The purpose of this repository is to aid in the development and deployment of YACS and it's dependencies.
This is your entry point as a YACS developer. To get started developing or deploying, follow these instructions.
If you have not used git or Github before, make sure your local git name and email are set, and you have your SSH key uploaded to Github. Follow these instructions from Github. Please use SSH instead of HTTPS.
Please install Docker and docker-compose. It is recommended to use either Linux or macOS.
If you use Linux, it is recommended to follow the post-installation sections "Manage Docker as a non-root user" and "Configure Docker to start on boot".
Running YACS on Windows may be possible, but it is not recommended and not supported.
-
Clone this repository
git clone git@github.com:YACS-RCOS/yacs-orchestra.git -
Enter the cloned directory
cd yacs-orchestra -
Run the one-time setup script
bin/yacs-prepare-development
You can now use the following command to run YACS:
bin/yacs-start-development
To stop YACS, press ctrl+c and run the following command
bin/yacs-stop-development