MyDiary

MyDiary is an online platform that enables a user to keep log of memorable experiences and also share it to the public if the user so desires.

Link to hosted Template

API Documentation

Hosted Application

Technologies Used

How to Use

How to test

code style

How to Contribute

Meet me!

License

Hosted Template

https://andrewinsoul.github.io/MyDiary/UI/index.html

Pivotal Tracker Link

https://www.pivotaltracker.com/n/projects/2183393

API Documentation

View the documentation of the API

Hosted Application

https://andy-diary.herokuapp.com

Technologies Used

• NodeJS
• Express
• Babel
• Eslint
• JsonWebToken
• Postgres Database
• Swagger

Installation

1. Git clone this repository `https://github.com/andrewinsoul/MyDiary.git`
2. Change your directory `cd MyDiary`
3. Install all dependencies using `npm install`
4. Start the app `npm start` for development
5. Navigate to `localhost:8000` in your browser

Tests

• Run dummy test using npm test
• Run database test using npm run db-test

Coding Style

• Airbnb: Airbnb is a coding style guide that guides developers to write clean codes

How to Contribute

- Fork this repository.
- Clone it.
- Create your feature branch on your local machine with ```git checkout -b your-feature-branch```
- Push your changes to your remote branch with ```git push origin your-feature-branch```
- Open a pull request to the master branch, and describe how your feature works

Ensure your codes follow AirBnB Javascript Styles Guide

Author

• Andrew Okoye

License

This project is licensed under the Apache License - see the LICENSE file for details