Django To-Do List Application

This is a simple to-do list application built with Django, following Test-Driven Development principles.

Features

• Create and manage personal to-do lists.
• Add items to lists.
• View lists.

Installation

Development Environment

1. Clone the repository:

   git clone https://github.com/jryusuf/To-Do-Django

2. Create a virtual environment (recommended):

   python3 -m venv venv
   source venv/bin/activate  # On Linux/macOS
   venv\Scripts\activate  # On Windows

3. Install dependencies:

   pip install -r requirements.txt

4. Running Tests:

   To run tests:

   python src/manage.py test lists #unit tests
   python src/manage.py test functional_tests #functional/e2e tests

5. Run migrations:

   python src/manage.py migrate

6. Run the development server:

   python src/manage.py runserver

   The application will be accessible at http://localhost:8000/.

Production Environment

The production environment is set up using Docker and Ansible.

1. Build the Docker image:

   docker build -t django-todo-app .

2. Deploy with Ansible:

   • Ensure you have Ansible installed and configured.
   • Modify the infra/deploy-playbook.yaml and infra/env.j2 files with your server details and environment variables.
   • Run the Ansible playbook:

     ansible-playbook infra/deploy-playbook.yaml -i <inventory_file> -e env=<environment_name>

     Replace <inventory_file> with your Ansible inventory file and <environment_name> with your environment name (e.g., production, staging).

   Note: Refer to the infra/deploy-playbook.yaml for detailed deployment steps and configuration.

Example Deployment

Example deployment at: http://ec2-18-133-232-224.eu-west-2.compute.amazonaws.com/

Local Docker Deployment

For local deployment using Docker, you can use the following steps:

1. Build the Docker image:

   docker build -t django-todo-app .

2. Run the Docker container:

   docker run -p 8000:8000 django-todo-app

   The application will be accessible at http://localhost:8000/.

   Alternatively, you can use Docker Compose if you have a docker-compose.yml file:

   docker-compose up --build