diff --git a/BUILD.md b/BUILD.md index d67190e..4796f5c 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,3 +1,27 @@ # Build Instructions -Under construction +## Backend + +For demo purposes, the backend uses sqlite3 as the database. The database is stored in the `backend` directory. + +For migrating the database, simply navigate to the backend directory and run `make migrate`, this will initialize the sqlite3 database. + +To build and run the main server binary: + +```bash +make build +make run +``` + +The server will be running on `localhost:8080`. This server does not hot reload, so you will need to restart the server after making changes. + +## Frontend + +The frontend is built using Vite with React. Vite handles hot reloading and bundling. + +First, you need to pull in the dependencies by running `npm install` in the frontend directory. +To spin up the development server, run `npm run dev`. This will start the development server on `localhost:3000`. Note that the backend server should be running for the frontend to work. + +## Release Builds + +Under Construction TM