Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lunaticmonk/postman-assignment
Software Engineer Assignment - Postman
https://github.com/lunaticmonk/postman-assignment
Last synced: 5 days ago
JSON representation
Software Engineer Assignment - Postman
- Host: GitHub
- URL: https://github.com/lunaticmonk/postman-assignment
- Owner: lunaticmonk
- License: mit
- Created: 2019-06-08T13:49:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T11:23:21.000Z (almost 2 years ago)
- Last Synced: 2024-04-20T12:11:29.017Z (7 months ago)
- Language: JavaScript
- Homepage: https://postman.lunaticmonk.space/
- Size: 132 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Postman Assignment(Twitter REST API)
To have an easy access, the API is deployed here: [https://postman.lunaticmonk.space](https://postman.lunaticmonk.space).
Please visit `/api/user` and `/api/tweet` for user and tweet resources respectively.
Endpoints are given below in this readme.
---
- [Endpoints](#endpoints)
- [Requirements](#requirements)
- [Setup](#setup)
- [Tests](#tests)
---
## Endpoints
The endpoints can be found at this public url: [https://documenter.getpostman.com/view/4519825/S1TbRZEY?version=latest](https://documenter.getpostman.com/view/4519825/S1TbRZEY?version=latest).
## Requirements
- Node.js (v8.11.3 preferable)
- MongoDB
- Yarn (`npm install -g yarn`)
## Setup
- Create a `.env` and copy the contents of `.env.default` in `.env`.
- Create a MongoDB user and give it `dbOwner` access to the database. Set the credentials in .env as well.
```shell
$ mongo
> use postman
> db.createUser({ user:"lunaticmonk", pwd: "lunaticmonk", roles: [{role: "dbOwner", db: "postman"}] })
```
```shell
$ npm install -g yarn
$ npm install -g nodemon
$ git clone https://github.com/lunaticmonk/postman-assignment.git
$ cd postman-assignment
$ yarn
$ yarn dev
// Alternative to above command to start server:
$ yarn start:daemon // to run the server as a daemon. install pm2 first by `npm install -g pm2`
// To launch the server in cluster mode:
$ yarn start:daemon -i 0 // install pm2 first by `npm install -g pm2`
```
- The API server will start at the given port in the .env. ex. `localhost:8000`.
## Tests
Mocha and Chai.js was used for the testing. Being a CRUD app with a very less business logic involved, only integration tests are written.
To run the tests:
`yarn test`
## Completed functionalities
- [x] User registration
- [x] User login
- [x] Follow, unfollow
- [x] Create, read, delete tweet
- [x] Unit/Integration tests
- [x] Like/unlike a tweet
- [x] Retweet
- [x] Replies and threading
## Scalability
While deploying to production, pm2 can be used in cluster mode to utilize all the cpu cores. That way, we can increase the workers, thereby distributing the load and utilizing the full computing power.
## License
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
- Copyright 2019