College and high school students make profiles and apply for medical opportunities in a job-posting format. If they are chosen, they will be emailed directly by the professionals who posted the postition. (the user profile contains student contact information). Pop-up windows are used for a lot of functionality, establishing a retro feel.
reference: https://code.visualstudio.com/docs/python/python-tutorial
install python from python.org
Install VS Code
Install VS Code Python extension
- Navigate into the Repository
- Download the zip folder from the repository
- Extract the folder
- Open the folder directory in VS Code
- Open the backend folder in VS Code
press Ctrl+Shift+P to open the command runner
search for and choose the "Python: Create Environment..." option
choose the "Venv" option
choose the "Python 3.11.8 64-bit /bin/python" option (or any Installed Python Version)
select the "Terminal" menu at the top of the screen and choose "New Terminal"
Installing packages reference:
Link to Download:
Under the Precompiled Binaries for Windows, download the A bundle of command-line tools for managing SQLite database files option, as it is needed to run the project smoothly.
After downloading SQLite3, unzip the folder and place it in a safe location. Then, for Windows, go to Edit the system environment variables in Settings. Select Environment Variables, then under System Variables, edit the Path variable by adding the location of the SQLite 3 folder.
Video for extra guidance: https://www.youtube.com/watch?v=2CAspm7YwTU
python -m venv venv
venv\Scripts\activate
python -m pip install fastapi[all]
python -m pip install uvicorn
python -m pip install sqlalchemy\
python3 -m venv venv
source venv/bin/activate
python -m pip install fastapi[all]
python -m pip install uvicorn
python -m pip install sqlalchemy
Make sure fastapi, uvicorn, and sqlalchemy are all downloaded from your package manager on your local device
navigate to main.py and run the file using:
python main.py
NPM is needed to run the frontend part of RateMyStudent. To install npm, follow these steps:
- Visit https://nodejs.org/en/download
- Download the lts version of the installer
- Run the installer
- Using an IDE of your choice, open up the project folder
- Open up a terminal instance
- Access the frontend folder by running
cd frontendin the terminal
Inside of rateMyStudent/frontend, run the following commands
npm install
npm install react-router-dom
npm install axios
npm install @dnd-kit/core
npm install react-redux
npm install @reduxjs/toolkit
Once those dependencies are done, you will be able to sucessfully run the frontend part of the application.
However, before you launch it, ensure that the backend server, backend/main.py is running in another terminal with the command python main.py. Once you have verified that the backend server, run the following command:
npm start
Then in your browser, navigate to http://localhost:5173/ and begin coding!