Skip to content

This a web application where a user can log in and create the tasks, this was built with the Django web application framework

License

Notifications You must be signed in to change notification settings

Saketh-Chandra/My_ToDO

Repository files navigation

This is a ToDO website made with Django

This a web application where a user can login and create the tasks, this was built with the Django web application framework

A running instance of it can be found at " https://my--todo.herokuapp.com/ ".

βœ”οΈ This a basic project for learning Django3

Resources:

πŸ“– How to use the repository?

βš™οΈ Setup

First we have to create virtual environments

On Windows:

py -m pip install --user virtualenv
py -m venv env
.\env\Scripts\activate

On macOS and Linux:

python3 -m pip install --user virtualenv
python3 -m venv env
source env/bin/activate

Leaving the virtual environment

deactivate

After setting up virtual environment do this!

git clone https://github.com/Saketh-Chandra/My_ToDO.git
cd My_ToDO
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

🐳 Using Docker Compose

In production, Django uses a WSGI server such as Gunicorn and a web server such as Nginx.

Architecture:

Request Flow

Request Flow Diagram

βš™οΈ Setup .env file

  • Edit the .env file

## .env file, Don't Share it with anyone!

SECRET_KEY='e^$9mt#)3niaz9b9pyxc1x(53&qq1^@iuy2)=5hhji1t+*o_0$'
DEBUG=False

## Super-User Credentials
SUPER_USER_NAME = 'root'
SUPER_USER_PASSWORD = 'root'
SUPER_USER_EMAIL = 'admin@email.com'

Usage

git clone https://github.com/Saketh-Chandra/My_ToDO.git
cd My_ToDO
docker-compose up -d

Run services in the background: docker-compose up -d

Run services in the foreground: docker-compose up --build

Inspect volume: docker volume ls and docker volume inspect my_todo_static

View networks: docker network ls

Bring services down: docker-compose down

:octocat: How to contribute?

All contributions are welcome! Code, documentation, graphics or even design suggestions are welcome; use GitHub to its fullest. Submit pull requests, contribute tutorials or other wiki content -- whatever you have to offer, it would be appreciated!

Please read CONTRIBUTING.md for details on contributing.

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

See the full list of contributors who participated in this project and statistics.

❗ Prerequisites aka requirements

Please read Prerequisite file for details.

πŸ“œ Changelog

Check the changelog here.

πŸ“œ I found some bugs or issues. Where do I report?

Report here in detail answering these questions:

  • What steps did you take to make the bug appear?
  • How can the bug be fixed? (In case you know)
  • Which OS and which all packages / softwares / dependencies are you using?
  • Have you tried any troubleshooting steps such as a reboot for example?
  • Have you followed the prescribed prerequisites?

πŸ“œ How do I contact the team?

Check here for the list of contributors. Contact one of them through their profiles.