Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emmanuelaaron/epicmail-api
https://github.com/emmanuelaaron/epicmail-api
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/emmanuelaaron/epicmail-api
- Owner: Emmanuelaaron
- Created: 2019-03-15T17:35:49.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-08T04:54:22.000Z (about 2 years ago)
- Last Synced: 2024-11-20T18:35:54.586Z (about 2 months ago)
- Language: Python
- Size: 114 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EpicMail-Api
[](https://travis-ci.org/Emmanuelaaron/EpicMail-Api)
[](https://coveralls.io/github/Emmanuelaaron/EpicMail-Api?branch=develop)
[](https://codeclimate.com/github/Emmanuelaaron/EpicMail-Api/maintainability)
## Getting started
You can clone this [repo](https://github.com/Emmanuelaaron/EpicMail-Api.git) on your local machine or checkout the user-interface on [gh-pages](https://emmanuelaaron.github.io/EpicMail/UI/temps/signin.html).
### Prerequisites
Install [python](https://www.python.org/downloads/release/python-371/) on your local machine
### Installing
Clone the this repo on your local machine
```
$ git clone https://github.com/Emmanuelaaron/EpicMail-Api.git
```
cd into the cloned directory, install the virtual environment and activate it, checkout to the most stable branch and install all the dependences.
```
$ cd develop
$ pip install virtualenv
$ virtualenv venv
$ source venv/Scripts/activate
$ git checkout develop
$ pip install flask
$ pip install PyJWT
$ pip install -r requirements.txt
$ python run.py
```
* copy the Url it into postman and put to run any endpoint of your preference in the table below with the url prefix ('/api/v2') for each endpoint.
HTTP Method | Endpoint | Functionality | Parameters
------------|----------|---------------|------------
POST | /auth/signup | User is able to signup | None
POST | /auth/login | User is able to login | None
POST | /messages | Creates a message| None
GET | /messages| Gets all received messages| None
GET | /messages/sent | Gets all sent messages | None
GET | /messages/ | Gets a specific message | message_id
DELETE | /messages/ | deletes a specific message | message_id
## Running Tests
Install pytest, activate the virtual environment and then run the tests
```
$ pip install pytest
$ pytest
```
You can checkout the code coverage by using the code below
```
$ pytest --cov=.
```
Make sure your virtual environment is activated
## Tools Used
* [python](https://www.python.org/downloads/release/python-371/)
* [Flask](http://flask.pocoo.org/) Micro web framework for python
* [pip](https://pip.pypa.io/en/stable/) package installer for python
* [Virtualenv](https://virtualenv.pypa.io/en/stable/) Tool used to created isolated programs for python
## Built with
So far this application has been built with
* [Python](https://www.python.org/downloads/release/python-371/)
* [Flask](http://flask.pocoo.org/)
## Contributions
To contribute to this project please create a branch off the develop after which you will create a pull request before it is merged back.
## Aurthor
By Emmanuel Isabirye