faisalmaqsood01 / readme_template

Project Name

Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. How to run tests
4. How to run lint
5. How to debug locally
6. License
7. Contact

About The Project

Provide some description for project.

Some important points.

• Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled
• Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled
• Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled

Built With

This section should list any major frameworks/libraries used to bootstrap your project.

• 
• 
• 
• 
• 
• 
• 
• 

Getting Started

This is an example of how you may give instructions on setting up your project locally.

Prerequisites

Required resource access for getting setup completed:

• Setting Git Hub Access using SSH key
• Given below Git Hub Repository Access https://github.com/repo1 https://github.com/repo2
• Azure Subscription Credential
• pyenv - to manage the Python version for this project. Required Python version is 3.7.4.
• pipenv - to manage a Python virtual environment and dependencies.
• Docker

Installation

The first thing to do is to clone the repository:

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Setup and activate virtual environment

   source venv/bin/activate
   

3. Then install the dependencies:

   (venv)$ pip install -r requirements.txt
   

4. Install postgress

sudo apt update -y
sudo apt install postgresql postgresql-contrib

5. Apply migrations

python manage.py migrate

6. Locally check server running command

python manage.py runserver

How to run tests

The easiest way to run all the tests is to use the command:

python3 manage.py test

How to run lint

Use the following command to run lint locally,

pipenv run lint

How to debug locally

Steps to mention the setup debugger locally.

Troubleshooting

Here you mention some common issues which most of the team facing this will help other devs to overcome issue with minimal time.

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - @your_twitter - [e-mail]

Project Link: https://github.com/your_username/repo_name