Journary is an online journal where users can pen down their thoughts and feelings. The front-end repo is here
Front-end https://journary.netlify.app/ Back-end https://journary.cleverapps.io/
-
Install
node, version 12 or greater -
Clone this repo and cd into it
git clone https://github.com/tope-olajide/Journary-backend.git cd Journary-backend -
Install all dependencies
npm install -
Start the app by running:
npm run dev
| HTTP VERB | ENDPOINT | FUNCTIONALITY |
|---|---|---|
| POST | api/user/signin | Sign in a user |
| POST | api/user/signup | Create a new user |
| GET | api/user/cancel-reminder/:email | Cancel Reminder |
| POST | api/user/set-all-reminders | Restart all reminders(incase the server crash) |
| PUT | api/user/update-profile | Update user's profile |
| POST | api/user/gallery | Save Image Url |
| GET | api/user/gallery | Fetch Image Galleries |
| DELETE | api/user/gallery/:imageId | Delete image |
| GET | api/user/ | Fetch user's profile |
| GET | api/user/get-reminder | Fetch reminder |
| POST | api/user/set-reminder | Save Reminder |
| GET | api/user/fetch-all-reminders | Fetch all reminders |
| GET | api/user/unsubscribe/:email | Cancel Reminder |
| GET | api/entry/search | Search for diary |
| POST | api/entry/ | Add new Entry |
| GET | api/entry/ | Fetch all public entries |
| GET | api/entry/private | Fetch all user's Private entries |
| GET | api/entry/public | Fetch all user's Public entries |
| PUT | api/entry/:entryId | Modify modify entry |
| DELETE | api/entry/:entryId | Delete user entry |
| GET | api/entry/:entryId | Fetch entries details |
| GET | api/entry/get-entry/:entryId | Fetch entry without updating the view count |
- NodeJS - A Javascript runtime built on chrome V8 engine that uses an event-driven non-blocking I/O model that makes it lightweight and efficient.
- ExpressJs - A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
- Postgres - A powerful, open source object-relational database system.
This project is licensed under the MIT License - see the LICENSE file for details
If you are interested in contributing to development of this project, follow the instructions below to contribute.
-
Fork the repository
-
Make your change
-
Commit your change to your forked repository
-
Provide a detailed commit description
-
Raise a pull request against the master branch
Yes!. This application is licensed under MIT, and it's open for everybody
- Temitope David Olajide - Fullstack Developer.