Installation Guide

• Requirements
• Video Guides
• Written Guides
  • Installing SnailyCAD
  • Updating SnailyCAD
  • Using pm2 to keep the SnailyCAD running in the background
  • Using Docker

Requirements

Please make sure to have all of these installed!

• GIT
• NodeJS v14 (Must be v14 or you'll run into problems!)
• MySQL

Video guides

• Quick Installation guide
• Installation Guide by Mr. Game Eagle
• How to update the CAD

Written guides

Installing SnailyCAD

1. Open Command Prompt
2. Run git clone https://github.com/Dev-CasperTheGhost/snaily-cadv3
3. Run cd snaily-cadv3
4. Run npm install and wait it to finish
5. Open the src folder
6. Make a copy of config.example.ts and rename to config.ts
7. Modify that where needed
8. Go back to your command prompt
9. Once done modifying, create a new database in XAMPP phpmyadmin, call it snaily-cad or whatever you called it in the config file
10. Import snaily-cad.sql into that database
11. Go back to your command prompt and make sure you are in the main folder (snaily-cadv3/)
12. Run npm start, this will start both client and server
13. Wait a few seconds until it logs "CAD IS RUNNING ON <port>"
14. The CAD should be running on http://localhost:3030 by default

Updating SnailyCAD

1. Run git pull origin main in the root folder of the CAD/MDT
   • I get an error saying Please commit or stash your changes, please checkout the troubleshooting guide
2. Run npm install also in the root folder of the CAD/MDT
3. Once that's finished you can start the CAD/MDT and all should be updated

Using pm2 to keep the SnailyCAD running in the background

1. Make sure to have correctly installed SnailyCAD
2. Install pm2 globally: npm install -g pm2
3. In the root folder, run pm2 start npm --name snailycad -- run start. This will start SnailyCAD in the background.
   • To stop: pm2 stop snailycad
   • To Restart: pm2 restart snailycad
   • To reload: pm2 reload snailycad
   • View logs: pm2 logs snailycad
   • Learn more about pm2

Using docker

Make sure that you have some understanding of Docker/hosting. This is mostly for advanced users only.

Thanks to @bound2 for adding Docker support! (#117)

1. Make sure that you have Docker installed on your machine (Download Docker)
2. Create a .env file in the root folder and add these values:
   • DB_HOST=database
   • DB_NAME=snaily-cad
   • DB_USER=root
   • DB_PASSWORD=YOUR_DB_PW_HERE
   • JWT_SECRET=YOUR_JWT_SECRET_HERE
   • PROFILE=production
3. Start it using docker-compose --env-file .env up (To run in the background: docker-compose --env-file .env up -d)
4. Wait for the services to fully start, CAD should be running.
   • CAD: http://localhost:3030
   • PhpMyAdmin: http://localhost:8080
   • Stop the CAD: docker compose down --rmi=local