https://github.com/orimdominic/post-it
API for a mini photo + text content blogging app, with sign up emails included
https://github.com/orimdominic/post-it
cloudinary jest jwt mongodb nodejs
Last synced: 2 months ago
JSON representation
API for a mini photo + text content blogging app, with sign up emails included
- Host: GitHub
- URL: https://github.com/orimdominic/post-it
- Owner: orimdominic
- Created: 2021-05-26T21:58:00.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-08T16:48:15.000Z (about 5 years ago)
- Last Synced: 2023-03-08T23:44:57.926Z (over 3 years ago)
- Topics: cloudinary, jest, jwt, mongodb, nodejs
- Language: TypeScript
- Homepage: https://documenter.getpostman.com/view/16008266/TzXzDcNR
- Size: 67.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/sudo-kaizen/post-it)
# post-it
A mini blogging app
## Prerequisites
- Yarn >= 1.x.x
- Node.js >= 14.x.x
- A Gmail account with the less secure apps option enabled for sending mails. Also make sure that unlock captcha has been disabled for the mail. [See here](https://accounts.google.com/b/0/DisplayUnlockCaptcha)
- A [Cloudinary](https://cloudinary.com/) account for accepting and storing images
- MongoDB server for storing posts. To setup MongoDB for your computer, see [Install MongoDB](https://docs.mongodb.com/guides/server/install/)
## Setup
1. Clone the repository and `cd` into the repository's folder
2. Run `yarn install` in the terminal of the repository's folder to install dependencies
3. Create a `.local.env` file to hold secret keys that will be used by the app
4. Copy the content of `.sample.env` to `.local.env` and fill the required data
5. Run `yarn create:jwtkeys` to generate JWT `.public.pem` and `.private.pem` files for JWT auth
6. Run `yarn start:dev` to start the application
7. The URL of the application's API will be displayed on your terminal.
## Documentation
The API for **Post It** was documented with Postman. [View the Post It API documentation](https://documenter.getpostman.com/view/16008266/TzXzDcNR)
## Tests
- Run unit tests with `yarn test:unit`
- Run integration tests with `yarn test:integration`