fistonhn/MyDiary

MyDiary is an online journey where user can pen down their though and feeling

MyDiary

Project Overview

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

Deployment

• A user interface on gh-pages can be found at : https://fistonhn.github.io/MyDiary/UI

• A heroku app for API can be found at : https://my-diary-fiston.herokuapp.com/api/v2/auth/signup

• The documenation of the API can be found at : https://my-diary-fiston.herokuapp.com/api/swaggerDocument

Features

• A user can create an account if he doesn't have one
• A user can log in to his account if he does have it
• A user can view all entries to their diary.
• A user can view the contents of a diary entry.
• A user can dd entry.
• A user can modify an entry.
• A user can delete an entry.

Built With

• Node.js
• Express framework
• Html
• CSS
• Javascript

Api Endpoints

• POST /auth/signup  - Create user account 
• POST /auth/signin  - Login a user
• POST /api/v1/entries - User can add an entry
• PATCH /api/v1/entries/:id -user can modify an entry
• GET /api/v1/entries - User can get all entries
• GET /api/v1/entries/:id - User can get specific entry
• DELETE /api/v1/entries/:id - User can delete an entry

Installation

• Run git clone https://github.com/fistonhn/MyDiary.git
• Run npm install to download and install all packages
• Run npm devStart to start the server
• And then Test the end points using postman or your browser

Contributing

You can contribute to this project by forking the project https://github.com/fistonhn/MyDiary.git

And then submit your changes by creating a new pull request https://github.com/fistonhn/MyDiary/compare

Author

HABIMANA Fiston

Acknowledgments

• Andela Kigali