https://github.com/mil100057/my_eicheesel
A Django, Python & JS Simulation & Tracking of long term Savings
https://github.com/mil100057/my_eicheesel
css django html5 javascript python3 savings savings-calculator savings-plan up-for-grabs
Last synced: about 2 months ago
JSON representation
A Django, Python & JS Simulation & Tracking of long term Savings
- Host: GitHub
- URL: https://github.com/mil100057/my_eicheesel
- Owner: Mil100057
- License: mit
- Created: 2024-11-14T11:54:10.000Z (5 months ago)
- Default Branch: product-docker-compose
- Last Pushed: 2024-12-08T08:54:23.000Z (5 months ago)
- Last Synced: 2025-01-16T05:13:08.532Z (3 months ago)
- Topics: css, django, html5, javascript, python3, savings, savings-calculator, savings-plan, up-for-grabs
- Language: JavaScript
- Homepage:
- Size: 1.63 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
HELP WANTED
If you want to contribute please contact me.
⚠️ ⚠️ ⚠️ Application still in debug mode
# 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:
```bash
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)
```
2. Prepare the environment:
```bash
nano .env
```
enter you ENV VARIABLES
```bash
DEBUG=0
SECRET_KEY=
API_KEY=
ALLOWED_HOSTS=localhost,127.0.0.1, #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
3. Start the application in detach mode:
```bash
docker compose up --detach
```
Once containers are running
enter in the terminal of your eicheesel-server-1 container
```bash
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: ``
- 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
3. **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
```bash
CSRF_TRUSTED_ORIGINS = ['http://localhost', 'http://127.0.0.1',
'http://localhost:8080', 'http://127.0.0.1:8080',
'']
```
## Support
For issues or questions, please create an issue in the repository.
---
Made with ❤️ by Mil100057