NanoBeepa Backend

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Modules
• Features
• API Docs
• Contributing
• License

Getting Started

These instructions will help you set up and run the project on your local machine.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Python (version 3.11.x)
• Poetry
• MySQL/MariaDB or PostgreSQL (require re-configuration)

Installation

1. Clone the repository:

   git clone https://github.com/fokusuma/NBBackend.git

2. Install package:

   poetry install

3. Copy and fill the env

   cp .env.example .env

4. Run makemigrations

   python manage.py makemigrations

5. Run migration

   python manage.py migrate

6. Load all fixtures (per module, product as example)

   python manage.py loaddata fixtures/product/*.json

7. Create superuser

   python manage.py createsuperuser

8. Run the server on localhost:8000 (important: follow the frontend domain)

   python manage.py runserver localhost:8000

9. Go to Django admin page

10. Input or import all required master data (important: shipping routes)

Modules

Coming soon

Features

Coming soon

API Docs

Coming Soon

Contributing

Coming Soon

License

Coming Soon