hngbackend2

HnG Portfolio

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• Python
• Django

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Check if python3 is installed

  python3 --version
  

• Else download from Python.org

Installation

1. Clone the repo

   git clone https://github.com/Murithijoshua/hngbackend2.git

2. Create virtual enviroment

   python3 -m venv env

3. Activate the virtual env

   source env/bin/activate

4. Install all the dependencies

   pip install -r requirements.txt

5. Run the application

   cd hngbackend2
   

   python manage.py migrate 
   

   python manage.py runserver
   

• running this on browser will fetch all data and POST data

  127.0.0.1:8000/api/all
  

Usage

this is still under_development

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/Murithijoshua/hngbackend2

Acknowledgements