Aida's List - aidaslist.xyz

Overview

A task tracking web app, built for simplicity. Originally designed to help a long-time client who needs computer assistance every now and then to keep track of what she needs help with, letting me see what tasks she has for me before we even connect.

Demo available at https://demo.aidaslist.xyz

Technologies Used

• Python
• Django
• Web Awesome component library
• Docker
• Docker Compose

Getting Started

• Local development
  1. Ensure Python is installed
  2. Clone the repository: git clone <repository_url>
  3. Navigate to the project directory and create a virtual environment: python -m venv venv && source venv/bin/activate
  4. Install the project's dependencies: pip install -r requirements.txt
  5. Start the development server: python manage.py runserver
• Production deployment
  1. Clone repo
  2. Build docker image: docker build -t aidaslist .
  3. Start container: docker run -d aidaslist
  4. Point web server (NGINX, Apache, etc.) at localhost:8000
• Environmental variables
  • SECRET_KEY
    • 60 character random string
  • DEBUG (default 0)
    • Set to 1 to enable debugging mode. Don't run debugging mode in production.
  • ALLOWED_HOSTS (default localhost)
    • Comma separated list of domains allowed to access the site
  • CSRF_TRUSTED_ORIGINS
    • Comma separated list of schemas + domains allowed to POST to the site
  • DB_ENGINE (default django.db.backends.sqlite3)
    • Change to the appropriate type if you want to use something other than sqlite
  • DB_NAME (default db/db.sqlite3)
    • Change to your DB name if not using sqlite
  • DB_HOST
  • DB_PORT
  • DB_USER
  • DB_PASSWORD
    • All self-explanatory
• Volumes
  • aidaslist_db:/app/db/
  • Can change the bind name, but this is required for persistent data

License

This project is licensed under Apache-2.0 license.