HackAtUCI / zothacks-2020-backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

zothacks-2020-backend-fundamentals

Basic overview

Basic Flask backend that has CRUD (Create, Read, Update, Delete) endpoints for a User that is stored in a Mongo Database

Try it!

πŸ‘©β€πŸ‘§ Clone repository

git clone https://github.com/hackuci/zothacks-2020-backend
cd zothacks-2020-backend

🐍 Create Python virtual environment

There are a good amount of depencies for this project -- it will be good practice to use a virtual environment, albeit not necessary.

On macOS and Linux:

python3 -m venv env

On Windows:

python -m venv env

Alternative for windows:

py -m venv env

The second argument is the location to create the virtual environment. Generally, you can just create this in your project and call it env.

βœ… Activate virtual environment

On macOS and Linux:

source env/bin/activate

On Windows Command Line:

.\env\Scripts\activate.bat

One Windows Powershell

.\env\Scripts\activate.ps1

πŸ“¦ Navigate to the repository folder and install packages

python -m pip install -r requirements.txt

Run the project without a debugger attached

$ python3 app.py

Check Postman Collection for Endpoint Documentation

About


Languages

Language:Python 99.6%Language:Procfile 0.4%