Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/platzi-master-c8/ms-forum
Micro Service of Forum for networking section
https://github.com/platzi-master-c8/ms-forum
Last synced: 27 days ago
JSON representation
Micro Service of Forum for networking section
- Host: GitHub
- URL: https://github.com/platzi-master-c8/ms-forum
- Owner: Platzi-Master-C8
- Created: 2021-11-28T13:36:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-08T19:04:47.000Z (almost 3 years ago)
- Last Synced: 2023-03-06T06:32:37.271Z (almost 2 years ago)
- Language: JavaScript
- Size: 663 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MS-Forum
This backend API is used as an interface for Forum interaction with backend.
## Steps to run & deploy
### Initial setup
For local environment setup for first time, please copy information from file .env.example to .env and run following command:
docker-compose up -d
that will setup postgres and PGAdmin 4 for initial setup.
After that, run all migrations:
migrations:run
After migrations are completed as an aditional step you can copy information inside ./tests/dummy-data.json and create a file under ./src/data/ with the name seed_data.json. It contains the information for demo/testing purposes.
### Running in dev
For running your server in dev environment please use the following command:
npm run dev
If everything is correct you will receive following message in console:
Server listening on port 3000
port 3000 is the default port and it is not yet configurable.
### Running in Production
For running your server in dev environment please use the following command:
npm run start
If everything is correct you will receive following message in console:
Server listening on port 3000
port 3000 is the default port and it is not yet configurable.
## Business Logic
## Endpoints
### Get Discussions
You can get a list of all products using endpoint `/api/discussions`by a GET HTTP Request, this list is used typically by the FrontEnd for picking values.
### Get Discussion by Id
You can get a list of all invoices using endpoint `/api/discussions/{id}` by a GET HTTP Request, this list can be used to access to a particular discussion id, it will always retrieve last version created in database. Below is a JSON example of this request answer:
```json
{
"id": 1,
"title": "Example Title",
"content": "Example Content",
"category": 1,
"createdAt": "2012-04-23T18:25:43.511Z",
"userId": 1,
"modifiedAt": null,
"modifiedBy": null,
"status": 1,
"discussionVersionNo": 1
}
```
### Create a new discussion
You can create a new discussion using endpoint `/api/discussions` by a POST HTTP request with following body:
```json
{
"title": "Example Title",
"content": "Example Content",
"categoryId": 1,
"userId": 1
}
```
This will return the created discussion with void comments as:
```json
{
"id": 1,
"title": "Example Title",
"content": "Example Content",
"category": 1,
"createdAt": "2012-04-23T18:25:43.511Z",
"userId": 1,
"modifiedAt": null,
"modifiedBy": null,
"status": 1,
"discussionVersionNo": 1
}
```
### Get all discussion likes
You can get a list of all products using endpoint `/api/likes/discussions` by a GET HTTP Request, this list is used typically by the FrontEnd for picking values. It retrieves a list of JSON objects with likes details:
```json
[{
"id": 1,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 1,
"isActive": true
}
,
{
"id": 2,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 2,
"isActive": true
}
,
{
"id": 3,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userID": 3,
"isActive": true
},
{
"id": 4,
"discussionId": 2,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 2,
"isActive": true
}]
```
### Give like/unlike to a discussion
You can give like to an existing discussion using endpoint `/api/likes/discussions` by a POST HTTP request with following body:
```json
{
"discussionId": 1,
"userId": 2
}
```
This will return the created like as:
```json
{
"id": 1,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 2,
"isActive": true,
"currentdiscussionLikes": 2
}
```
if the like is already created, isActive will be false.
### Get likes for a discussion and user
You can give like to an existing discussion using endpoint `/api/likes/discussions` by a GET HTTP request. This can be filtered using params :
`discussionId` -> optional param
`userId` -> optional param
`groupBy` -> optional param
if `userId` is present (`/api/likes/discussions?userId=2`) then this will return the like as:
```json
[{
"id": 1,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 2,
"isActive": true,
"currentdiscussionLikes": 3
},
{
"id": 4,
"discussionId": 2,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 2,
"isActive": true,
"currentdiscussionLikes": 1
}]
```
if `groupBy` is present and it corresponds to a JSON object property (`/api/likes/discussions?userId=2&groupBy='discussionId'`) then endpoint will return the like as:
```json
[{
"discussionId": 2,
"count": 1
},
{
"discussionId": 1,
"count": 3
}
```
if `discussionId` is present and it corresponds to a JSON object property (`/api/likes/discussions?discussionId=1`) then endpoint will return the like as:
```json
[{
"id": 1,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 1,
"isActive": true,
"currentdiscussionLikes": 3
}
,
{
"id": 2,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userId": 2,
"isActive": true,
"currentdiscussionLikes": 3
}
,
{
"id": 3,
"discussionId": 1,
"likedAt": "2012-04-23T18:25:43.511Z",
"userID": 3,
"isActive": true,
"currentdiscussionLikes": 3
}]
```
Also you can use `groupBy` to obtain the count of every discussion (`/api/likes/discussions?groupBy=discussionId`) the endpoint will return:
```json
[{
"discussionId": "1",
"count": 3
}
,
{
"discussionId": "2",
"count":1
}
]
```
if nothing is found, then you will receive a 404 HTTP status.
## To Do