Super Record is an information management system which serves the purpose of automating business processes of a supermarket in an effort to improve efficiency, accuracy, performance and accountability.
1. User Accounts Management
2. Purchase Management
3. Stock/Products Management
4. Sales Management
5. Expense Management
6. Report Generation
- Python 3.7 - popular general-purpose scripting language suited for web development
- Django 2.2 - A web application framework for Python
Setting up project in development environment
- Ensure Python 3.7 is installed by running:
python --version
- Ensure pipenv is installed or you can follow the intallation from PIPENV
- Create a folder for the project by running:
mkdir myprojectfoldername
- cd in to
myprojectfoldername - Create a virtualenv using pipenv by running:
pipenv shell
- Clone the project repo by running:
git clone https://github.com/anyric/super-record.git
Create a database locally on your machine named superrecord and add the name as a value to the environment variable. Use the env.sample template to create a .env file
- Export the .env file by running
. .env
- Inside the project root folder i.e src/, run the command below in your console
python manage.py migrate
python manage.py runserver
- Navigate to
http://127.0.0.1:8000/ - Login with the default setup credential
username=adminandpassword=1234@adminand then remember to edit the credentials - Configure the system to your need.
- Export the .env file as describe above if you haven't
- Run the command below:
python manage.py test
- docker
- docker-compose
- Clone the repository and navigate to the root folder.
Run the command below:
make build
Run the command below:
make start
Run the command below:
make test
make stop
make clean
- Anyama Richard