Home

A simple chore app.
Explore the docs »

Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

Screenshots - COMING SOON

This project started as simple chores app for my family to track chores.

(back to top)

Built With

(back to top)

Getting Started

Welcome to LenoreChore! This guide will help you set up and run the application using Docker and Docker Compose.

Prerequisites

Make sure you have the following installed on your system:

Step 1: Create a `.env` File

Create a .env file in the root directory of the project. This file will store environment variables required to run the application. Below is an example of the variables you need to define:

DEBUG=0
SECRET_KEY=mysupersecretkey
DJANGO_ALLOWED_HOSTS=localhost
CSRF_TRUSTED_ORIGINS=http://localhost
SQL_ENGINE=django.db.backends.postgresql
SQL_DATABASE=LenoreChore
SQL_USER=LenoreChoreuser
SQL_PASSWORD=somepassword
SQL_HOST=db
SQL_PORT=5432
DATABASE=postgres
DJANGO_SUPERUSER_PASSWORD=suepervisorpassword
DJANGO_SUPERUSER_EMAIL=someone@somewhere.com
DJANGO_SUPERUSER_USERNAME=supervisor
VITE_API_KEY=someapikey
TIMEZONE=America/New_York

Adjust these values according to your environment and application requirements.

Step 2: Create a `docker-compose.yml` File

Create a docker-compose.yml file in the root directory of the project. Below is an example configuration:

services:
  frontend:
    image: novanglus96/LenoreChore_frontend:latest
    container_name: LenoreChore_frontend
    networks:
      - LenoreChore
    restart: unless-stopped
    expose:
      - 80
    env_file:
      - ./.env
  backend:
    image: novanglus96/LenoreChore_backend:latest
    container_name: LenoreChore_backend
    command: /home/app/web/start.sh
    volumes:
      - LenoreChore_static_volume:/home/app/web/staticfiles
      - LenoreChore_media_volume:/home/app/web/mediafiles
    expose:
      - 8000
    depends_on:
      - db
    networks:
      - LenoreChore
    env_file:
      - ./.env
  db:
    image: postgres:15
    container_name: LenoreChore_db
    volumes:
      - LenoreChore_postgres_data:/var/lib/postgresql/data/
    env_file:
      - ./.env
    networks:
      - LenoreChore
    environment:
      - POSTGRES_USER=${SQL_USER}
      - POSTGRES_PASSWORD=${SQL_PASSWORD}
      - POSTGRES_DB=${SQL_DATABASE}
  nginx:
    image: novanglus96/lenoreapps_proxy:latest
    container_name: LenoreChore_nginx
    ports:
      - "8080:80"
    volumes:
      - LenoreChore_static_volume:/home/app/web/staticfiles
      - LenoreChore_media_volume:/home/app/web/mediafiles
    depends_on:
      - backend
      - frontend
    networks:
      - LenoreChore

networks:
  LenoreChore:

volumes:
  LenoreChore_postgres_data:
    external: true
  LenoreChore_static_volume:
    external: true
  LenoreChore_media_volume:
    external: true

Step 3: Run the Application

Start the services:

bash docker compose up -d

Access the application in your browser at http://localhost:8080.

Notes

Adjust exposed ports as needed for your environment.
If you encounter any issues, ensure your .env file has the correct values and your Docker and Docker Compose installations are up to date.

Enjoy using LenoreChore!

(back to top)

Usage

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!