Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leoelicos/matey
Social network back end
https://github.com/leoelicos/matey
crud-api mongoosejs
Last synced: about 1 month ago
JSON representation
Social network back end
- Host: GitHub
- URL: https://github.com/leoelicos/matey
- Owner: leoelicos
- Created: 2022-06-24T07:21:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-08T13:16:01.000Z (over 1 year ago)
- Last Synced: 2024-10-14T05:25:26.730Z (about 1 month ago)
- Topics: crud-api, mongoosejs
- Language: JavaScript
- Homepage: https://matey.herokuapp.com/api/users
- Size: 237 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# matey
  
## Introduction
This RESTful social network back end allows developers to perform CRUD API calls like view, add, update and delete. It would allow a developer to test requests using Insomnia to prepare for front-end integration.
This CLI application uses npm packages `Express`, `Mongoose` and `nodemon`.
I made this app in order to learn how to implement a MongoDB ODM using Mongoose.
Deployed API: https://matey.herokuapp.com/api/users
## Installation
### 0. Required
| Programs | Download links |
| ---------- | ------------------------------------------------- |
| `Node` | https://nodejs.org/en/download/ |
| `MongoDB` | https://www.mongodb.com/docs/manual/installation/ |
| `Insomnia` | https://insomnia.rest/download |
### 1. Git clone and go inside
```sh
git clone https://github.com/leoelicos/matey.git
cd matey
```
### 2. Install dependencies, (optionally) run seed
```sh
cd ..
npm install
```
## Usage
1. Start the server: `npm start`
2. Access the APIs with Insomnia
## Video Demo
https://user-images.githubusercontent.com/99461390/175824930-744c309d-6375-4f2e-bffa-e9a98946c363.mp4
Video is also available on [YouTube](https://www.youtube.com/watch?v=U6-XyI3JuZo)
## Social Network API
### Root endpoint and API endpoint
| Root endpoint | Endpoint |
| ----------------------- | -------- |
| `http://localhost:3001` | `/api` |
### Example
```sh
GET http://localhost:3001/api/users
```
### Users
#### Create, read, update and delete users
| Request | Endpoint | Parameter | Function | Example JSON body |
| ------- | -------- | ---------- | --------------------------------------------- | -------------------------------------------------- |
| GET | `/users` | | Read all users | |
| GET | `/users` | `/:userId` | Read a user with `userId` | |
| POST | `/users` | | Create a user with JSON body | `{"username": "harry",`
`"email": "[email protected]"}` |
| PUT | `/users` | `/:userId` | Update a user with JSON body and its `userId` | `{"username": "harry",`
`"email": "[email protected]"}` |
| DELETE | `/users` | `/:userId` | Delete a user with `userId` | |
### Friends
#### Attach and delete friends from a user's friend list
| Request | Endpoint | Parameter | Endpoint | Parameter | Function |
| ------- | -------- | ---------- | ---------- | ------------ | --------------------------------------------------------- |
| POST | `/users` | `/:userId` | `/friends` | `/:friendId` | Attach a friend with `friendId` to a user with `userId` |
| DELETE | `/users` | `/:userId` | `/friends` | `/:friendId` | Delete a friend with `friendId` from a user with `userId` |
### Thoughts
#### Create, read, update and delete thoughts
| Request | Endpoint | Parameter | Function | Example body |
| ------- | ----------- | ------------- | ----------------------------------------------- | ------------------------------------------------------------------------------- |
| GET | `/thoughts` | | Get all thoughts | |
| GET | `/thoughts` | | Get a thought by its `id` | |
| POST | `/thoughts` | | Create a thought with JSON body | `{"thoughtText": "Life's good",`
`"username": "harry",`
`"userId": 5edf}` |
| PUT | `/thoughts` | `/:thoughtId` | Update a thought with JSON body and `thoughtId` | `{"email": "[email protected]"}` |
| DELETE | `/thoughts` | `/:thoughtId` | Remove a thought with `thoughtId` | |
### Reactions
**Add or remove reactions to a thought**
| Request | Endpoint | Parameter | Endpoint | Parameter | Function | Example body |
| ------- | ----------- | ------------- | ------------ | -------------- | ------------------------------------------------------------------- | --------------------------------------------------------- |
| POST | `/thoughts` | `/:thoughtId` | `/reactions` | | Add a reaction to a thought with `thoughtId` and JSON body | `{"reactionBody": "OMG really?",`
`"username": "ron",` |
| DELETE | `/thoughts` | `/:thoughtId` | `/reactions` | `/:reactionId` | Remove a reaction with `reactionId` from a thought with `thoughtId` | |
## Example of API response
Request:
```sh
GET http://localhost:3001/api/users/62b889b433eb59d6a552eb3e
```
Response:
```sh
{
"_id": "62b889b433eb59d6a552eb3e",
"username": "ronweasley",
"email": "[email protected]",
"thoughts": [
{
"_id": "62b88a5b33eb59d6a552eb5d",
"thoughtText": "Spiders are scary",
"username": "ronweasley",
"createdAt": "Monday, 27 June 2022",
"reactions": [
{
"reactionBody": "No, they're not!",
"username": "hermionegranger",
"_id": "62b88a9733eb59d6a552eb66",
"reactionId": "62b88a9733eb59d6a552eb67",
"createdAt": "Monday, 27 June 2022"
}
],
"__v": 0,
"reactionCount": 1
}
],
"friends": [],
"friendCount": 0
}
```
## Screenshots
### Screenshot: Insomnia GET Users
TBA
## Credits
- BCS Resources
## License
© Leo Wong
Licensed under the [MIT License](./LICENSE).