avyayjain / todo_application

This is Todo application system

Installation

1. Clone the repository

git clone https://github.com/avyayjain/todo_application.git

2. Install the requirements to install the requirements run the following command

pip install -r requirements.txt

3. do alembic migration

alembic revision --autogenerate -m "initial migration"
alembic upgrade head

4. create the .env file and add the following variables

DATABASE_URL
DATABASE_USER
DATABASE_PASSWORD
DATABASE_DB
SECRET_KEY
ALGORITHM
ACCESS_TOKEN_EXPIRE_MINUTES

5. run the server

python3 -m uvicorn main:app --host 0.0.0.0 --port 8000

6. you can also build the docker container by running the following command

docker build -t todo_application .

7. you can run the docker container by running the following command

docker run -d -p 8000:8000 todo_application

Testing

1. now you can go to the postman the collection by visiting this url

https://www.postman.com/technical-saganist-64650375/workspace/projects/collection/23939640-60350063-a735-4dd8-b45c-aa41ff4d3762?action=share&creator=23939640

2. you can import the collection in the postman and test the api's

3. you can also go to the swagger documentation by going to the following url

http://localhost:8000/docs