MyDiary is an online journal where users can pen down their thoughts and feelings.
An Andela Bootcamp Challenge.
For API documentation, please visit here
- Live Link
- Features
- API Endpoints
- Technologies Stack
- Management
- Contributions
- Author
- Bugs
- Acknowledgments
My-Diary front end is hosted on gh-pages My-Diary UI and the backend is on Heroku My-Diary API
- 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
| 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 |
- Clone this project with
https://github.com/StevenDerrick/My-Diary.git. - Head to project directory
cd My-Diary
- Navigate to UI/html folder
cd UI/html - These are HTML and CSS based pages that can be run directly in your browser.
- Install the project dependencies
npm install - Launch the server
npm start
| Frontend-UI | Backend-API |
|---|---|
| HTML | Nodejs/Express |
| CSS | Mocha |
| JS | Travis-CI |
This project is managed using Pivotal Tracker.
- Explain why you're making a change.
- Please consider the scope of your change.
- Please modify only one template per pull request.
- The more you can make me understand the change you're making, the more likely I'll be to accept your contribution quickly.
No known bugs. If you spot one, kindly email me @ ishimwesteven1@gmail.com