Our student made app, for international students at sac state.

Everything is oficially switched over to fastApi from Flask, the backend comes with a requirements.txt file, before you install everything I recommend you create a python venv by cd-ing into backend and running.

python -m venv venv

then this to activate it, commands will vary by the console you user

. venv/Scripts/activate

source venv/bin/activate

then run this to install all the packages

pip install -r requirements.txt

I made a makefile to run commands, it works on gitbash but if you're having trouble, just go into the Makefile and copy paste the commands.

to run the server

make watch

or

uvicorn server:app --reload

if you have trouble with Makefile.

This command will run the server and watch for changes on save, so you don't have to manually restart the server everytime.

git add .

git commit -m "your message"

git push origin main

If you have already set up the upstream

git push

Avoid pushing to main/production until features are complete, you should not be able to by default. Avoid using -force commands as much as possible.

More questionable commands:

This command will override all your current changes and set your branch to main: Do not run this unless you want to loose all your work.

git reset --hard origin/main

Make sure you have everything installed in the backend and the front-end.

make install

or the default command

flutter pub get

from the backend folder

make watch

or default

uvicorn server:app --reload

From the front end folder I recommend using the using the debug button in vscode to run the flutter project, this will watch for changes automatically

Ensure you have mongoDB running in the background, you should be able to open Compass and be able to connect to the default port.

To check if the backend is running you can try opening localhost:8000/docs on the browser; Alternatively you can use Postman, to test each individual endpoint