okonri / django-ra-erp

A Django based framework to create diverse business solutions, equipped with a reporting engine and a responsive dashboard.

Ra Framework

A light-weight, effective, Django based framework to create various business applications, resource planing and management systems.

If offers a ready made platform where you can start to create data entry pages and attach various reports to them.

Features

• A customizable responsive dashboard (built on top of Django's admin).
• A Reporting Engine to compute and chart various and complex reports like time series and crosstab.
• A widget system to display various reports in one page.
• Extendable and customizable
• Python 3.6 / 3.7 / 3.8/ Django 2.2, 3.0 Compatible

Installation

$ pip install django-ra-erp

Quick start

1. Create a virtual environment and install Django Ra ERP from Pypi

   $ virtualenv ra-erp
   $ source ra-erp/bin/activate
   $ pip install django-ra-erp

2. Once installed, Ra provides a command to generate a new project, which would contains all the dependencies needed.

   $ ra-admin start my_project_name

   You can always integrate Ra to your existing project, it's fairly simple. Here is the guide Integrating into an existing django project

3. Let's run the preparation commands and get started !

   $ ./manage.py migrate
   $ ./manage.py createsuperuser
   $ ./manage.py runserver

Documentation

Available on Read The Docs

Please Proceed to the tutorial Create a sales application Part 1

Testing and contribution

To run the test suite, first, create and activate a virtual environment. Then clone the repo, install the test requirements and run the tests:

# 1. Clone and install requirements
$ git clone [email protected]:ra-systems/django-ra-erp.git
$ cd tests
$ python -m pip install -e ..
$ python -m pip install -r requirements/py3.txt

# 2. Set the test database connection details in the environment
$ export DATABASE_NAME=<database name>
$ export DATABASE_USER=<database user>
$ export DATABASE_PASSWORD=<database password if any>

# 3. Run the tests
$ ./runtests.py
# And for Coverage report
$ coverage run --include=../* runtests.py [-k]
$ coverage html

For more information on contributing, we honor Django's guidelines.