tjas-erp

⭐ Mark the project with a star. 👀 Watch the project for receive news.

🇧🇷 Acesse esta página em Português do Brasil.

Advanced Python/Django ERP application for product, employee and sales registration, detailing, editing, deletion and listing, with access control. Features and evolutions planned can be found in the Main Features Available section.

Main Features Available

To learn more about upcoming releases, refer to the Project Roadmap

• Employees' registration, detailing, editing and listing;
• Products' registration, detailing, editing, deletion and listing;
• Sales' registration, detailing, editing, deletion and listing;
• Public and private pages access control;
• Connection to persist informations in local data base;
• 76% of test coverage.

Getting Started

This is an example of how you may set up the project locally in your computer. We strongly recommended that you use virtual environments to run the application, we recommend Virtualenv (or any other of your choice). Read it, create and activate the virtual environment inside the project folder before steps 5.

To get a local copy up and running follow these steps:

1. Make sure you have Python 3.10.11+ installed or do it from Python.org or from Anaconda;
2. Make sure you have Git installed or do it from Git-scm.com;
3. Access the folder you want to save the project, then clone the repo there

   git clone https://github.com/tjas/tjas-erp

4. Access the project folder;
5. Install the project dependencies

   pip install -r requirements.txt

6. Make sure PostgreSQL is running on your computer and that the db_erp database has been created. The database name, access and other related settings must be verified and can be changed in the DATABASES variable of settings.py file, located in main application folder (core module).
7. Run the migrations

   python manage.py migrate

8. Run Django project

   python manage.py runserver

9. Then access aplication at http://127.0.0.1:8000/

Contributing

1. Fork it!
2. Create your feature branch:

   git checkout -b my-new-feature

3. Add files changed:

   git add .

4. Commit your changes:

   git commit -m "Add some useful comment here"

5. Push to the branch:

   git push origin my-new-feature

6. Submit a pull request
   • Add a title and description that let clear your suggestion;
   • Use the English language for comments and branch names;
   • After your pull request is merged, you can safely delete your branch.

Tests

For unit testing creation it was been used the tools available in the django.test module of Django and in unittest library of Python. To assess test coverage, the coverage package was used.

Performing the Tests

From inside the project folder, run:

python manage.py test

Checking Tests Coverage

From inside the project folder, run the tool and generate reports:

coverage run --omit='*/venv/*' manage.py test
coverage report
coverage html

Contact

Thiago Jorge Almeida dos Santos, project author and maintainer.

Licence

• Code distributed under MIT License.