Installation Guide for OpenRxERP¶

Follow these steps to install the OpenRxERP POS system:

Recommended Environment¶

• Operating System: Debian 11
• Python Version: 3.12.5
• Django Version: 5.1.1
• Other requirements are listed in requirements.txt.

Steps to Install OpenRxERP¶

1. Clone the Repository¶

Open your terminal and clone the repository using git clone.

1
2

git clone https://github.com/chirag-v/openrx.git
cd openrx

2. Set Up a Virtual Environment¶

Create and activate a virtual environment to manage dependencies.

1
2

python3 -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install Dependencies¶

Install the required Python packages using pip.

1

pip install -r requirements.txt

4. Set Up Environment Variables¶

Create a .env file in the root directory of the project and add the necessary environment variables.

1
2
3
4
5
6

SECRET_KEY='your-secret-key'
DB_NAME='your-database-name'
DB_USER='your-database-user'
DB_PASSWORD='your-database-password'
DB_HOST='your-database-host'
DB_PORT='your-database-port'

5. Configure Database¶

Ensure that PostgreSQL is installed and running. Create a new PostgreSQL database and user with the credentials specified in the .env file.

6. Apply Migrations¶

Run the Django migrations to set up the database schema.

1

python manage.py migrate

7. Create a Superuser¶

Create an admin user to access the Django admin interface.

1

python manage.py createsuperuser

8. Collect Static Files¶

Collect all static files into the STATIC_ROOT directory.

1

python manage.py collectstatic

9. Run the Development Server¶

Start the Django development server.

1

python manage.py runserver

10. Access the Application¶

Open your web browser and navigate to http://localhost:8000 to access the application. Use the admin credentials created earlier to log in to the Django admin interface at http://localhost:8000/admin.

Summary¶

1. Clone the repository.
2. Set up a virtual environment.
3. Install dependencies.
4. Configure environment variables.
5. Set up and configure the database.
6. Apply migrations.
7. Create a superuser.
8. Collect static files.
9. Run the development server.
10. Access the application via a web browser.