0. Introduction
1. Installation (Debian based distributions)
2. Populate the database
3. Start the development server
4. Used technologies
5. License
6. Commit Emoticons
Balto is an FLOSS project for the management of a kennel and the recording of daily activities
usually carried out by volunteers.
Main features:
- Creation of groups with specific permissions.
- Registration and management of users and assignment to qualifying groups.
- Setting the features of the structure: legal information, areas and boxes.
- Registration of the types of activities to be carried out and linked with a qualifying permission.
- Registration of animals with their characteristics: general, descriptive, health and management.
- Multicast notification system.
- Events registration.
- Research in events with different filters.
Install python 3.X & pipenv: apt install python3 pipenv
Change directory: cd {insert_your_folder}
Clone repository: git clone [email protected]:0xfederico/balto.git
Change directory: cd balto
Create virtualenv and install all dependencies: pipenv install
Migrate: python3 manage.py migrate
Create superuser: python3 manage.py createsuperuser
Activate the virtualenv end spawn a shell inside: pipenv shell
Two execution options are supported:
- Run server on localhost:
python3 manage.py runserver
⚠️ Only you can access the website.⚠️
Now you can access the website at http://127.0.0.1:8000 - Run server inside your LAN:
python3 manage.py runserver 0.0.0.0:8000
⚠️ All devices in your own network can access the website, it is useful to see the website on smartphones.⚠️
Now you can access the website at http://{YOUR_LAN_IP_ADDRESS}:8000
- Python 3.9
- Django Web Framework
- Django Crispy Forms
- Pillow library
- Django sslserver
- Netifaces library
- ChartJS library
- Bootstrap Framework v4.6
- Fullcalendar library
GNU AFFERO GENERAL PUBLIC LICENSE Version 3.
Please read the LICENSE file.
The meaning of emoticons at the beginning of commit: https://gist.github.com/parmentf/035de27d6ed1dce0b36a