Magic Cloud

Where the machine creates your code


Project maintained by ServerGardens Hosted on GitHub Pages — Theme by mattgraham

Getting started with Magic

There are multiple ways to use Magic, depending upon whether or not you just want to try it out locally on your development machine, use the Docker images to more rapidly getting up to speed, or deploy it to your production server. In this section we’ll walk you through these different methods of getting started.

Using Docker

The easiest way to get started is to download the docker-compose.yml file, assuming you have Docker installed, and then execute the following in a terminal window where you saved the file. This is the exact same process for both Windows, Mac and Linux.

docker-compose up

When your Docker containers have started, open your browser and go to http://localhost:5555, and use the default configuration settings for MySQL, choose a root password, crudify your Magic database, type your name and email address when you generate a key pair, and Magic should work out of the box without any hassle. In the video below I am illustrating this process.

Download the code

If you don’t want to use Docker, you can also configure your development environment locally on your development machine using the code directly. If so you will first of all need the following components.

  1. Visual Studio or VS Code + DotNet CLI and SDK
  2. NodeJS
  3. Angular
  4. MySQL or Microsoft SQL Server

In the video below I go through the manual setup process.

Deploy Magic

The easiest method to deploy Magic into production, is to follow this recipe, which guides you through setting up your VPS server to host Magic. Notice, if this is too complex for you, we do provide this as a service for a fee.

Update Magic

If you’re using the docker images, this is incredibly easy, and simply requires you to stop Magic for some few seconds, update the core, and restart your docker containers again. Below is the entire recipe. Execute the following terminal commands one at the time. Make sure you execute the following in the same folder as where your main Magic “docker-compose.yml” file is.

docker-compose down
docker pull servergardens/magic-frontend
docker pull servergardens/magic-backend
docker-compose up -d

Once the above has finished executing, you should have the latest release either locally or on your VPS.

Support

If you have a support request of private nature, you can send us an email at thomas@servergardens.com. If you want to submit a feature request or a bug report, you can do such through the project’s GitHub Issues.

License

Magic is 100% Open Source and free to use, also in proprietary and closed source applications. The only exception is if you improve the frontend dashboard, or improve one of its plugins, at which point you must make your improvements publicly available for others to use.

Go Pro

ServerGardens.Com provides a whole range of professional services based upon Magic. Check out our website for details.