Lunaticsatoshi / django-test

A test django app

Django Pricing API

A base template for a simple Django based backend API

Features

• Get Pricing
• Create Pricing config

🏗️ Built With

🧩 Getting Started

To get a local copy up and running follow these simple steps.

Clone the repo

1. Clone the repository using the following command

git clone https://github.com/Lunaticsatoshi/django-test.git
# After cloning, move into the directory having the project files using the change directory command
cd django-test

Starting the development server with docker 🐳 (Recommended)

Prerequisites

Make sure you have Docker and docker-compose installed on your machine.

Steps to start the server

Adding Docker support soon

Starting the development server without docker 📡

Prerequisites

Make sure you have Python installed on your machine.

NOTE:

The project was made with python version 3.10.

1. Create a virtual environment using pipenv where all the required python packages will be installed

# Use this on Windows
py -m venv env
# Use this on Linux and Mac
python3 -m venv env

2. Active venv

# Windows
env/bin/activate
# Linux and Mac
source ./env/bin/activate

3. Install all the project Requirements

pip install -r requirements.txt

-Apply migrations and create your superuser (follow the prompts)

# create migrations
python manage.py makemigrations

# apply migrations and create your database
python manage.py migrate

# Create a user with manage.py
python manage.py createsuperuser

4. Create Pricing config Open http://127.0.0.1:8000/admin to open the admin panel in the browser.

5. Run the development server

# run django development server
python manage.py runserver

Visit http://127.0.0.1:8000/ to get the api routes

🔐 License

This project is licensed under the MIT License - see the LICENSE.md file for details

Suggestions and Bug Reports

Since this is an open source project all suggestions, requests and bug reports are always welcomed. If you have any don't forget to leave them in the issues section. But we recommend creating an issue or replying in a comment to let us know what you are working on first that way we don't overwrite each other.