Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.45 KB

README.md

File metadata and controls

23 lines (16 loc) · 1.45 KB

CleanRoute Backend

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.

IMPORTANT

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:

  1. Setup and run the ML server
  2. Setup and run Go backend server
  3. Setup and run frontend client

Prerequisites

  1. Make sure you have Go installed in your system. This article could help with that.
  • You can verify that Go is installed by running go version command and getting a version similar to 1.20 or 1.21 or 1.22
  1. Install air a tool similar to nodemon but for Go. Install through installation instruction from this GitHub repository

Installation instructions

  1. Create a .env file and replace xxxx with your own secret values.
  2. Just run air in terminal and see what happens, if it says running..., 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.