The-Collectors

The Collectors is a team of students working on a project for the Software Design & Documentations course at Rensselaer Polytechnic Institute. This project's purpose and design is to consolidate all clubs and organizations affiliated with RPI.

Team Members

Justin Chang
Charles Chae
David Finck
Junseob Kim
Bill Wang

How to set up the development environment

Directions to install necessary packages and dependencies for the project. First clone the repository on your machine.

Installing Python

1. Download and install latest Python at https://www.python.org/downloads/
2. When installing, make sure that:
   • Python.exe is added to PATH
   • pip is also installed

Installing MongoDB

1. Download the MongoDB Community Server at https://www.mongodb.com/try/download/community
2. Make sure install MongoDB Compass is checked. You can also download at https://www.mongodb.com/try/download/compass
3. After MongoDB Compass is installed, it should open up with a new connection window. Save and connect the default connection.

Installing Packages and Dependencies

1. Download and install latest Node.js at https://nodejs.org/en. This will also download npm which we need. Check automatically install necessary tools when prompted. Restart your computer.
2. Open up a new terminal and cd to the frontend folder. Type npm install. This should install all necessary frontend packages.
3. Open up a new terminal and cd to the backend folder. Type pip install pipenv in ther terminal. If you are getting an error that the command pip does not exists, it means you haven't added Python Scripts to your PATH.
4. Once pipenv is installed, type pipenv shell and then pip install -r requirements.txt. This installs all backend packages we need.

Launching the project

Directions for launching the project once the necessary packages have been installed.

1. To start the backend, navigate to the backend folder in the terminal and start a virtual environment with pipenv shell. Then type uvicorn main:app --reload.
   • note: type /docs to the end of the URL to see the FastAPI backend commands.
2. To start the frontend, navigate to the frontend folder in the terminal and type npm start.
3. To see the list of clubs in the database, start MongoDB and connect to the localhost database (default - should be saved). You will see The Collectors database on the left hand side.