Skip to content

Latest commit

 

History

History
92 lines (66 loc) · 2.37 KB

README.md

File metadata and controls

92 lines (66 loc) · 2.37 KB
Raw

Welcome to Todoist_FastAPI 👋

Version Documentation Twitter: mihirh21

Todoist is a full stack todo application built with FARM stack. FastAPI and MongoDB on the backend and ReactJS on the frontend.

🏠 Homepage

How to run Locally?

Backend

To run the backend, you need to have local mongodb instance running on you can setup a deployed instance using MongoDB Atlas.

Setting up python environment

Run the following to create a virtual environment for the project. (Assuming you have python installed on local machine)

python -m virtualenv env
# OR
python -m venv env
#OR
python -m venv --system-site-packages env
#OR
python3 -m venv env
# if still doesn't work, google is your best friend!

If you're running the deployed instance, make sure to change the database connection string in .env file on the backend.

Setting up .env file

To setup .env file on the backend, create a file named .env in /backend/app. Add the following in the .env file.

JWT_SECRET_KEY=<RAMDOM_STRING>
JWT_REFRESH_SECRET_KEY=<RANDOM_SECTURE_LONG_STRING>
MONGO_CONNECTION_STRING=<MONGO_DB_CONNECTION_STRING>
# mongodb://localhost:27017/ <-- for local running instances

Installing dependencies

Assuming you are in the base directory.

cd backend
pip install -r requirements.txt

Activating virtual environment

# Windows
env/Scripts/activate
# MacOs + Linux
source env/bin/activate

Running the backend

Assuming you are in the backend directory.

uvicorn backend.app:app --reload

Author

👤 Mihir Hadavani

Show your support

Give a ⭐️ if this project helped you!