/andela-societies-backend

Andela societies is an application that allows fellows to log and track points for their societies

Primary LanguagePython

Codacy Badge Maintainability CircleCI Coverage Status

Society-platform ✍

API for an Andela Societies.

Insert Description here

  • API

This App exposes endpoints that allows clients/Users to interact with Andela society Platform.

  • Available Resource Endpoints

Method Endpoint Usage
POST /api/v1.0/login Login user.

Getting Started 🕵

  • To run on local machine git clone this project :
 $ git clone https://github.com/AndelaOSP/andela-societies-backend.git

Copy and paste the above command in your terminal, the project will be downloaded to your local machine.

  • To consume API in client of choice navigate to:
<Insert Hosted site here>

Prerequisites

The application is built using python: flask framework.

Flask is a microframework for the Python programming language.

To Install python checkout:

https://www.python.org/

Installing

For this section I will assume you have python3 and it's configured on your machine.
Navigate to the folder you cloned and run:

  • Install Requirements
$ cd src
$ pip install -r requirements.txt
  • Configure Environment.
<Insert Config here>

Note replace the value for DEV_DATABASE with real database path and SECRET with a strong string value

  • Configure database
<Insert Config here>
  • Run App 🏃
$ cd src
$ python manage.py runserver

The app should be accessiable via : http://127.0.0.1:5000/

Running the tests

$ cd src
$ python manage.py test
  • Coding style tests

Pep8 standards are followed in project.

$ cd src
$ pep8 api --count

Deployment 🚀

Built With 🏗 🔨⚒

  • Flask - The web framework used
  • Flaskrestplus - Extension for Flask that adds support for quickly building REST APIs.

Contributing 👍

  • Please Fork me! :-)

Versioning ⚙

Authors 📚

  • AndelaOSP

License 🤝

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

Acknowledgments 🙏