Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 2.98 KB

README.md

File metadata and controls

131 lines (99 loc) · 2.98 KB
Raw

HELP WANTED If you want to contribute please contact me.

⚠️ ⚠️ ⚠️ Application still in debug mode

img.png

Eicheesel 🐿️

A savings and long-term investment simulation application by Mil100057

     /\___/\
    (  o o  )
    (  =^=  ) 
     (____))
    /      \

Disclaimer

⚠️ Please read carefully:

  • This application is for testing and simulation purposes only
  • No guarantees are provided regarding calculation results
  • You are responsible for your data security
  • The application only performs basic calculations and storage
  • No financial advice are provided

Quick Start

Prerequisites

  • Docker
  • Docker Daemon running
  • Buildx for choosing your version
  • In settings.py add an ALPHAVANTAGE API KEY you can get one here https://www.alphavantage.co

Installation

  1. Clone the repository and Build the Docker container:
gh repo clone Mil100057/My_Eicheesel
#or
git clone https://github.com/Mil100057/My_Eicheesel.git
cd My_Eicheesel
docker buildx build --platform=linux/amd64 -t eicheesel .    #(example for linux AMD version)
docker buildx build --platform=linux/arm64 -t eicheesel .    #(example for linux ARM version)
  1. Prepare the environment:
nano .env

enter you ENV VARIABLES

DEBUG=0
SECRET_KEY=<YOUR_SECURE_KEY>
API_KEY=<YOUR_AV_API_KEY>
ALLOWED_HOSTS=localhost,127.0.0.1,<your_host_adress_if_needed>    #Please look below also
DB_NAME=eicheesel_db
DB_USERNAME=eicheesel
DB_PASSWORD=eicheesel
DB_HOST=db
DB_PORT=5432

exit nano and save .env by CTRL+X and Y

  1. Start the application in detach mode:
docker compose up --detach

Once containers are running enter in the terminal of your eicheesel-server-1 container

python manage.py migrate 
python manage.py createsuperuser
python manage.py collectstatic --no-input

⚠️ Important: superuser credentials are mandatory, choose a strong password!

Accessing the Application

  • URL: http://localhost:8080

Please Signup

or

Login as admin

  • Username: <your_super_user_name>
  • Password: <your_password>

Administration

  • Admin panel available at: http://localhost:8080/admin/
  • Use this interface to manage credentials and access the database

Usage Guide

Initial Setup

  1. Configure Categories

    • Go to Settings → Catégorie(s) in the sidebar
    • Select or create categories for your simulations

  2. Start Simulating

    • Click "Ajouter une simulation" to begin a new simulation

Customizing Categories

To modify category types:

  1. Navigate to the simulation folder
  2. Edit models.py
  3. Modify the Category class as needed

Customizing your webhost

in settings.py modify

CSRF_TRUSTED_ORIGINS = ['http://localhost', 'http://127.0.0.1',
                        'http://localhost:8080', 'http://127.0.0.1:8080',
                        '<your_host_adress_if_needed:8080>']

Support

For issues or questions, please create an issue in the repository.

Made with ❤️ by Mil100057