Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tjas/tjas-erp
Advanced Python/Django ERP Application.
https://github.com/tjas/tjas-erp
bootstrap django erp postgres postgresql python
Last synced: 13 days ago
JSON representation
Advanced Python/Django ERP Application.
- Host: GitHub
- URL: https://github.com/tjas/tjas-erp
- Owner: tjas
- License: mit
- Created: 2023-06-03T01:21:29.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-15T23:00:29.000Z (7 months ago)
- Last Synced: 2024-05-02T03:49:15.148Z (7 months ago)
- Topics: bootstrap, django, erp, postgres, postgresql, python
- Language: Python
- Homepage:
- Size: 41 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# tjas-erp
[](./README.md)
[](https://hits.seeyoufarm.com)
[](https://github.com/tjas/tjas-erp/blob/master/LICENCE)
[](https://github.com/tjas/tjas-erp/graphs/commit-activity)
[](https://github.com/tjas/tjas-erp/stargazers)
[](https://github.com/tjas/tjas-erp/watchers)
[](https://github.com/tjas/tjas-erp/forks)
[](https://www.python.org/)
[](https://www.djangoproject.com/)
[](https://www.postgresql.org/)
> ⭐ Mark the project with a star. 👀 Watch the project for receive news.
>
> 🇧🇷 Acesse esta página em [Português do Brasil](./README_pt-br.md).
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](#main-features-available) section.
## Main Features Available
> To learn more about upcoming releases, refer to the [Project Roadmap](https://github.com/users/tjas/projects/2/views/1)
* 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](https://virtualenv.pypa.io/en/latest/) (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](https://www.python.org/) or from [Anaconda](https://www.anaconda.com/);
2. Make sure you have Git installed or do it from [Git-scm.com](https://git-scm.com/);
3. Access the folder you want to save the project, then clone the repo there
```sh
git clone https://github.com/tjas/tjas-erp
```
4. Access the project folder;
5. Install the project dependencies
```py
pip install -r requirements.txt
```
6. Make sure [PostgreSQL](https://www.postgresql.org/) 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
```py
python manage.py migrate
```
8. Run Django project
```py
python manage.py runserver
```
9. Then access aplication at
## Contributing
1. Fork it!
2. Create your feature branch:
```sh
git checkout -b my-new-feature
```
3. Add files changed:
```sh
git add .
```
4. Commit your changes:
```sh
git commit -m "Add some useful comment here"
```
5. Push to the branch:
```sh
git push origin my-new-feature
```
6. Submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-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```](https://docs.djangoproject.com/pt-br/4.2/topics/testing/) module of Django and in [unittest](https://docs.python.org/3/library/unittest.html) library of Python. To assess test coverage, the [coverage](https://pypi.org/project/coverage/) package was used.
### Performing the Tests
From inside the project folder, run:
```sh
python manage.py test
```
### Checking Tests Coverage
From inside the project folder, run the tool and generate reports:
```sh
coverage run --omit='*/venv/*' manage.py test
coverage report
coverage html
```
## Contact
**Thiago Jorge Almeida dos Santos**, project author and maintainer.
[](https://www.linkedin.com/in/thiago-tjas) [](https://www.youtube.com/@thiago_tjas) [](https://www.instagram.com/thiago.tjas/) [](http://thiago-tjas.com/) [](https://github.com/tjas)
## Licence
* Code distributed under [MIT License](https://github.com/tjas/tjas-erp/blob/master/LICENCE).