StevenDerrick / My-Diary

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

📘 My-Diary 📝

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

An Andela Bootcamp Challenge.

For API documentation, please visit here

Table of Contents

• Live Link
• Features
• API Endpoints
• Technologies Stack
• Management
• Contributions
• Author
• Bugs
• Acknowledgments

Live Link 🌐

My-Diary front end is hosted on gh-pages My-Diary UI and the backend is on Heroku My-Diary API

Features 🚀

• View all entries
• View a specific entry
• User can a modify an entry
• User can delete an entry
• User can create an account
• User can create an entry
• User can sign in

API Endpoints 💧

HTTP Method	End point	Public Access	Action
POST	/v1/auth/signup	true	Create a user in the API
POST	/v1/auth/signin	true	User can sign in the API
POST	/v1/entries	true	Create an entry
PATCH	/v1/entries/entryId	true	Modify a specifc entry
DELETE	/v1/entries/entryId	true	Delete an entry
GET	/v1/entries/	true	Fetch all entries
GET	/v1/entries/entryId	true	Fetch a specific entry

Prerequisites 🔧

• Clone this project with https://github.com/StevenDerrick/My-Diary.git.
• Head to project directory cd My-Diary

UI

• Navigate to UI/html folder cd UI/html
• These are HTML and CSS based pages that can be run directly in your browser.

Server

• Install the project dependencies npm install
• Launch the server npm start

Technologies Stack ⚙️

Frontend-UI	Backend-API
HTML	Nodejs/Express
CSS	Mocha
JS	Travis-CI

Management 📝

This project is managed using Pivotal Tracker.

Contribution Guidelines 👬

1. Explain why you're making a change.
2. Please consider the scope of your change.
3. Please modify only one template per pull request.
4. The more you can make me understand the change you're making, the more likely I'll be to accept your contribution quickly.

Bugs 🐛

No known bugs. If you spot one, kindly email me @ [e-mail]

Author 💻

Steven Ishimwe

Acknowledgments 🙇

Andela Rwanda