{"id":21186772,"url":"https://github.com/emmanuelaaron/epicmail-api","last_synced_at":"2025-03-14T20:18:39.982Z","repository":{"id":34455927,"uuid":"175865262","full_name":"Emmanuelaaron/EpicMail-Api","owner":"Emmanuelaaron","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-08T04:54:22.000Z","size":117,"stargazers_count":0,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-01-21T13:06:53.834Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Emmanuelaaron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-15T17:35:49.000Z","updated_at":"2019-04-04T17:00:14.000Z","dependencies_parsed_at":"2022-08-27T17:21:36.687Z","dependency_job_id":null,"html_url":"https://github.com/Emmanuelaaron/EpicMail-Api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmanuelaaron%2FEpicMail-Api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmanuelaaron%2FEpicMail-Api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmanuelaaron%2FEpicMail-Api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Emmanuelaaron%2FEpicMail-Api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Emmanuelaaron","download_url":"https://codeload.github.com/Emmanuelaaron/EpicMail-Api/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243639558,"owners_count":20323511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T18:26:09.477Z","updated_at":"2025-03-14T20:18:39.958Z","avatar_url":"https://github.com/Emmanuelaaron.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EpicMail-Api\n\n[![Build Status](https://travis-ci.org/Emmanuelaaron/EpicMail-Api.svg?branch=develop)](https://travis-ci.org/Emmanuelaaron/EpicMail-Api)\n[![Coverage Status](https://coveralls.io/repos/github/Emmanuelaaron/EpicMail-Api/badge.svg?branch=develop)](https://coveralls.io/github/Emmanuelaaron/EpicMail-Api?branch=develop)\n[![Maintainability](https://api.codeclimate.com/v1/badges/6be725b6eef421b3bdb2/maintainability)](https://codeclimate.com/github/Emmanuelaaron/EpicMail-Api/maintainability)\n\n\n## Getting started\nYou 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).\n### Prerequisites\nInstall [python](https://www.python.org/downloads/release/python-371/) on your local machine\n\n### Installing\nClone the this repo on your local machine\n```\n$ git clone https://github.com/Emmanuelaaron/EpicMail-Api.git\n```\ncd into the cloned directory, install the virtual environment and activate it, checkout to the most stable branch and install all the dependences.\n```\n$ cd develop\n$ pip install virtualenv\n$ virtualenv venv\n$ source venv/Scripts/activate\n$ git checkout develop\n$ pip install flask\n$ pip install PyJWT\n$ pip install -r requirements.txt\n$ python run.py\n```\n* 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.\n\nHTTP Method | Endpoint | Functionality | Parameters \n------------|----------|---------------|------------\nPOST | /auth/signup | User is able to signup | None\nPOST | /auth/login | User is able to login | None\nPOST | /messages | Creates a message| None\nGET | /messages| Gets all received messages| None\nGET | /messages/sent | Gets all sent messages | None\nGET | /messages/\u003cint:message_id\u003e | Gets a specific message | message_id \nDELETE | /messages/\u003cint:message_id\u003e | deletes a specific message | message_id\n\n## Running Tests\nInstall pytest, activate the virtual environment and then run the tests\n```\n$ pip install pytest\n$ pytest\n```\nYou can checkout the code coverage by using the code below\n```\n$ pytest --cov=.\n```\nMake sure your virtual environment is activated\n\n\n## Tools Used\n* [python](https://www.python.org/downloads/release/python-371/)\n* [Flask](http://flask.pocoo.org/) Micro web framework for python\n* [pip](https://pip.pypa.io/en/stable/) package installer for python\n* [Virtualenv](https://virtualenv.pypa.io/en/stable/) Tool used to created isolated programs for python\n\n## Built with\nSo far this application has been built with\n* [Python](https://www.python.org/downloads/release/python-371/)\n* [Flask](http://flask.pocoo.org/)\n\n\n## Contributions\nTo contribute to this project please create a branch off the develop after which you will create a pull request before it is merged back.\n\n## Aurthor\nBy Emmanuel Isabirye\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmanuelaaron%2Fepicmail-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femmanuelaaron%2Fepicmail-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmanuelaaron%2Fepicmail-api/lists"}