LenoreCraft

A simple woodworking/craft project tracking app.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Screenshots - COMING SOON

This project evolved as a way to keep track of my woodworking projects and all the parts/cuts needed to complete them.

It probably can be expanded to use for general crafting projects but it's main purpose was geared towards woodworking.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Welcome to LenoreCraft! 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:

• Docker
• Docker Compose

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=lenorecraft
SQL_USER=lenorecraftuser
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 .env.db File

Create a .env.db 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:

POSTGRES_USER=lenorecraftuser
POSTGRES_PASSWORD=somepassword
POSTGRES_DB=lenorecraft

Make sure these match the settings in .env file!

Step 3: 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/lenorecraft_frontend:latest
    container_name: lenorecraft_frontend
    networks:
      - lenorecraft
    restart: unless-stopped
    expose:
      - 80
    env_file:
      - ./.env
  backend:
    image: novanglus96/lenorecraft_backend:latest
    container_name: lenorecraft_backend
    command: /home/app/web/start.sh
    volumes:
      - lenorecraft_static_volume:/home/app/web/staticfiles
      - lenorecraft_media_volume:/home/app/web/mediafiles
    expose:
      - 8000
    depends_on:
      - db
    networks:
      - lenorecraft
    env_file:
      - ./.env
  db:
    image: postgres:15
    container_name: lenorecraft_db
    volumes:
      - lenorecraft_postgres_data:/var/lib/postgresql/data/
    env_file:
      - ./.env.db
    networks:
      - lenorecraft
  nginx:
    image: novanglus96/lenoreapps_proxy:latest
    container_name: lenorecraft_nginx
    ports:
      - "8080:80"
    volumes:
      - lenorecraft_static_volume:/home/app/web/staticfiles
      - lenorecraft_media_volume:/home/app/web/mediafiles
    depends_on:
      - backend
      - frontend
    networks:
      - lenorecraft

networks:
  lenorecraft:

volumes:
  lenorecraft_postgres_data:
    external: true
  lenorecraft_static_volume:
    external: true
  lenorecraft_media_volume:
    external: true

Step 4: Run the Application

1. Start the services:

   docker compose up -d

2. 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 LenoreCraft!

(back to top)

Usage

(back to top)

Roadmap

• Projects
• Part Lists
• Material Lists
• Tasks
• Shopping List
• Tools
  • Board Feet Calculator
• Simplify Setup - Single .env file

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Support

Or

Contact

John Adams - Lenore.Apps@gmail.com

Project Link: https://github.com/Novanglus96/LenoreCraft

(back to top)

Acknowledgements

A heartfelt thanks to our Patrons for their generous support! Your contributions help us maintain and improve this project.

⭐ Thank You to Our Supporters:

Want to see your name here? Support us on Patreon to join our amazing community and shape the future of LenoreCraft!

(back to top)