https://github.com/oneirocom/magickml-docs
Documentation for Magick, the visual programming tool for AI Agents
https://github.com/oneirocom/magickml-docs
Last synced: about 1 year ago
JSON representation
Documentation for Magick, the visual programming tool for AI Agents
- Host: GitHub
- URL: https://github.com/oneirocom/magickml-docs
- Owner: Oneirocom
- Created: 2024-07-12T19:52:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T22:26:00.000Z (almost 2 years ago)
- Last Synced: 2024-08-03T00:30:52.295Z (almost 2 years ago)
- Language: MDX
- Homepage: https://magickml-docs.vercel.app
- Size: 6.25 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Magick Documentation Site
Welcome to the Magick documentation site repository. This site contains comprehensive documentation for Magick, the powerful visual IDE for creating AI agents.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Before you begin, ensure you have the following installed on your system:
- [Node.js](https://nodejs.org/) (version 14 or later recommended)
- [npm](https://www.npmjs.com/) (usually comes with Node.js)
### Installation
1. Clone the repository:
```
git clone https://github.com/Oneirocom/magick-docs.git
cd magick-docs
```
2. Install the dependencies:
```
npm install
```
### Running the Development Server
To start the development server, run:
```
npm run dev
```
This command starts the development server. Open [http://localhost:3000](http://localhost:3000) in your browser to view the site. The page will reload if you make edits to the source files.
## Project Structure
Here's a brief overview of the important directories in this project:
- `/pages`: Contains the main pages of the documentation site.
- `/components`: Reusable React components used throughout the site.
- `/styles`: CSS and styling related files.
- `/public`: Static assets like images and fonts.
## Contributing
We welcome contributions to improve the Magick documentation. Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for details on our code of conduct and the process for submitting pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Support
If you encounter any issues or have questions, please:
1. Check our [FAQ](https://docs.magick.com/faq) for common questions and answers.
2. If you can't find an answer, please open an issue in this repository.
3. For more interactive support, join our [Discord community](https://discord.gg/magick).
Thank you for your interest in improving Magick's documentation!