CourseSwaps

Demo

Check out a demo of the website here: Live demo

Installation

Frontend

To run the frontend, run the following commands in your virtual environment:

cd frontend
npm install

In the frontend directory, create a file called .env and add the following line:

VITE_GOOGLE_CLIENT_ID=YOUR_GOOGLE_CLIENT_ID
VITE_APP_API_URL=http://127.0.0.1:7000

To run the frontend, in the same frontend directory, run the following command:

npm run dev

Backend

To run the backend, run the following commands in your virtual environment:

cd backend
pip install -r requirements.txt

Recommended Python version: 3.11

In the backend directory, create a file called .env and add the following line:

DATABASE_URL=sqlite:///database.db
SECRET_KEY=YOURSUPERSECRETKEY

To run the backend, in the same backend directory, run the following command:

python app.py

Running Test

Check out a live demonstration of setting up testing here: Loom Video Demo

To setup the tests:

1. Click on the tests folder
2. Create a new file to test a specific functionality -- preferably bunch tests in the same blueprint of file together.
3. The naming convention for the test should be (test_what you are testing) for example test_authentification
4. Run the test by clicking the titration flask icon. You should be able to run the specific file that you want.
5. After runing the specific file click on the back-end section to run tests in all back-end files to ensure your code hasnt broken other segments of the app.