Getting started

Installation

$ pip install django-ra-erp

Create an empty project form scratch

  1. Create a virtual environment and install ra-framework from Pypi
$ mkvirtualenv ra-env (or use `virtualenv ra-env` if you don't have mkvirtualenv)

$ pip install django-ra-erp
  1. Ra provides a command to generate a new project with all needed settings in place.
$ ra-admin start project_name

This will create a django project under the directory project_name.

  1. Run the usual commands needed for any django project
$ ./manage.py migrate
$ ./manage.py createsuperuser
$ ./manage.py runserver
  1. Done !! Your site should now up and running at http://localhost:8000. Enter your super user credentials and login.

Integrating into an existing Project

Please follow to the next section Integrating Ra into an existing project

Running the tests

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

$ git clone git+git@github.com:ra-systems/RA.git
$ cd cd ra/tests
$ python -m pip install -e ..
$ python -m pip install -r requirements/py3.txt
$ ./runtests.py
# For Coverage report
$ coverage run --include=../* runtests.py [-k]
$ coverage html

For more information about the test suite and contribution, we honor https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/.