This is the backend repository of CleanRoute application. The parent repo can be found here.
Please use bash/zsh shell for typing commands. Windows users please use GitBash for this purpose.
Before you begin with frontend setup: Make sure you've completed the backend setup and the server is up and running.
Recommended steps for bootstrapping the servers:
- Setup and run the ML server
- Setup and run Go backend server
- Setup and run frontend client
- Make sure you have Go installed in your system. This article could help with that.
- You can verify that
Go
is installed by runninggo version
command and getting a version similar to 1.20 or 1.21 or 1.22
- Install
air
a tool similar to nodemon but for Go. Install through installation instruction from this GitHub repository
- Create a .env file and replace
xxxx
with your own secret values. - Just run
air
in terminal and see what happens, if it saysrunning...
, then you're good to go and your Go backend server is up and running. Otherwise, just try to debug the issue. Maybe you've not installed a tool properly, or it's not in your $PATH variable or something that I might have missed in the instructions, so please reach out to me to improve the instructions.