Skip to content

MyDiary is an online journal where users can pen down their thoughts and feelings.

Notifications You must be signed in to change notification settings

Nduhiu17/MyDiary

Repository files navigation

MyDiary-API

Build Status Coverage Status PEP8

Description

It is an API that enables CRUD methods for creating a Diary entry where users can can pen dwn their feelings

Development

Clone the repository:

https://github.com/Nduhiu17/MyDiary.git

Check out to the server branch by: $git checkout develop

Ensure you have the following:

1. postgres
2. python3.6
3. Flask
4. Postman

Create a virtualenv and activate it by running the following commands.

$python3.6 -m venv virtual

$source virtual/bin/activate

Dependencies

  • Install the project dependencies:

$ pip install -r requirements.txt

You can run the tests by running:

$pytest

After setting up the above. Run the application by:

$```FLASK_APP=app flask run``

Test the endpoints registered on Postman:

1.End point to registering a user

https://diary-server.herokuapp.com/api/v1/register/

  1. End point to login in a user

https://diary-server.herokuapp.com/api/v1/login/

  1. End point to get all entries

https://diary-server.herokuapp.com/api/v1/entries/

  1. End point to get a single entry

https://diary-server.herokuapp.com/api/v1/entries/0

  1. End point to add an entry.

https://diary-server.herokuapp.com/api/v1/entries/

  1. End point to update an entry.

https://diary-server.herokuapp.com/api/v1/entries/2

  1. End point to delete an entry.

https://diary-server.herokuapp.com/api/v1/entries/1

User interface

Please click on the link below to view the user interface design

https://nduhiu17.github.io/MyDiary/

Author

Antony Nduhiu

About

MyDiary is an online journal where users can pen down their thoughts and feelings.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published