njokuchidinma/loginapi

TEAM MIRAGE

Setup, Installation and Contribution Instructions

Prerequisites

1. Ensure you have python3 version >=3.8 installed. To find out about this, Open a command prompt or terminal and type python3 -v.
2. You have a text editor (preferably VScode) installed on your computer
3. You have mysql set up as it is what we will be using

Contributing Rules

1. Clone repository

git clone   [email protected]:hngx-org/Mirage-food-backend.git 

or

git clone https://github.com/hngx-org/Mirage-food-backend.git

2. Checkout to a branch using the following format ft-(e.g git checkout -b ft-getallusers)

NOTE: All Pull requests should be made toward the development branch.

Create and Activate Virtual Environment

Navigate into the folder you cloned the project

python3 -m venv virtual
source virtual/bin/activate

Ensure that this file is hidden inside the gitignore

Create dotenv file for storing secrets and credentials

touch .env

Ensure that this file is hidden inside the gitignore

Sample dotenv file will have the following structure:

SECRET_KEY='secret'
DB_NAME='mydb'
DB_USER='user'
DB_PASSWORD='pass123'

Configure your project secrets and credentials in this file

Install Dependencies

pip3 install -r requirements.txt

or

python3 -m pip install -r requirements.txt

Setup Database

SetUp your Database and add the Db name, password and user to your dotenv file Now Migrate

python3 manage.py migrate

Run the application

python3 manage.py runserver

Open the application on your browser 127.0.0.1:8000.

Making a Commit

Ensure to follow these steps when committing:

1. git add .
2. git commit -m <message here>
3. git pull origin development
4. git push origin

Opening a Pull request

1. Go to github
2. Open a new Pull Request to the Development Branch and not the Main Branch.

Technology used

• Python 3.10.12
• Django == 4.2.4