Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fredm23579/nosql-social-network-backend-api
Backend API for a social network application built using Node.js, Express.js, and MongoDB
https://github.com/fredm23579/nosql-social-network-backend-api
Last synced: about 1 month ago
JSON representation
Backend API for a social network application built using Node.js, Express.js, and MongoDB
- Host: GitHub
- URL: https://github.com/fredm23579/nosql-social-network-backend-api
- Owner: fredm23579
- Created: 2024-05-08T03:06:28.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T01:57:15.000Z (7 months ago)
- Last Synced: 2024-05-28T10:26:50.243Z (7 months ago)
- Language: JavaScript
- Homepage: https://github.com/fredm23579/nosql-social-network-backend-api/tree/main/nosql-social-network-backend-api
- Size: 239 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NoSQL Social Network Backend API
## Description
This is the backend API for a social network application built using Node.js, Express.js, and MongoDB. It provides endpoints for user authentication, managing user profiles, creating and interacting with thoughts (posts), and handling friend connections.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Database Models](#database-models)
- [Directory Structure](#directory-structure)
- [Contributing](#contributing)
- [License](#license)
## Features
- User registration and authentication using JWT
- CRUD operations for user profiles
- Create, read, update, and delete thoughts
- Add and remove reactions to thoughts
- Add and remove friends from a user's friend list
## Technologies Used
- Node.js
- Express.js
- MongoDB with Mongoose
- Bcrypt for password hashing
## Demo Link
## GitHub Repo Link
## Installation
### Clone the repository
```bash
git clone https://github.com/fredm23579/nosql-social-network-backend-api.git
```
### Install the dependencies
```bash
cd nosql-social-network-backend-api
npm install
```
### Set up environment variables
Create a `.env` file in the root directory and provide the following variables:
```
MONGODB_URI=
PORT=
```
Replace ``, and `` with your actual values.
### Start the server
```bash
npm start
```
The server will start running at `http://localhost:`.
## Usage
You can use tools like Insomnia or Postman to test the API endpoints.
Explore the available API endpoints to interact with users, thoughts, reactions, and friends.
## API Endpoints
### User Routes
- `GET /api/users`: Get all users
- `GET /api/users/:userId`: Get a single user by ID
- `POST /api/users`: Create a new user
- `PUT /api/users/:userId`: Update a user by ID
- `DELETE /api/users/:userId`: Delete a user by ID
### Thought Routes
- `GET /api/thoughts`: Get all thoughts
- `GET /api/thoughts/:thoughtId`: Get a single thought by ID
- `POST /api/thoughts`: Create a new thought
- `PUT /api/thoughts/:thoughtId`: Update a thought by ID
- `DELETE /api/thoughts/:thoughtId`: Delete a thought by ID
- `POST /api/thoughts/:thoughtId/reactions`: Add a reaction to a thought
- `DELETE /api/thoughts/:thoughtId/reactions/:reactionId`: Remove a reaction from a thought
### Friend Routes
- `POST /api/users/:userId/friends/:friendId`: Add a friend to a user's friend list
- `DELETE /api/users/:userId/friends/:friendId`: Remove a friend from a user's friend list
## Database Models
### User Model
- `username` (String, Required, Unique, Trimmed)
- `email` (String, Required, Unique, Valid Email)
- `thoughts` (Array of ObjectId, ref: 'Thought')
- `friends` (Array of ObjectId, ref: 'User')
- `friendCount` (Virtual, Retrieves the count of friends)
### Thought Model
- `thoughtText` (String, Required, Must be between 1 and 280 characters)
- `createdAt` (Date, Default: Current timestamp, Getter to format timestamp)
- `username` (String, Required)
- `reactions` (Array of nested documents created with the reactionSchema)
- `reactionCount` (Virtual, Retrieves the count of reactions)
### Reaction Schema
- `reactionId` (ObjectId, Default: new ObjectId)
- `reactionBody` (String, Required, Maximum of 280 characters)
- `username` (String, Required)
- `createdAt` (Date, Default: Current timestamp, Getter to format timestamp)
## Directory Structure
```
nosql-social-network-backend-api/
├── config/
│ ├── db.js
│ └── index.js
├── controllers/
│ ├── friendController.js
│ ├── thoughtController.js
│ ├── userController.js
│ └── index.js
├── middleware/
│ ├── errorMiddleware.js
├── models/
│ ├── Reaction.js
│ ├── Thought.js
│ ├── User.js
│ └── index.js
├── routes/
│ ├── friendRoutes.js
│ ├── thoughtRoutes.js
│ ├── userRoutes.js
│ └── index.js
├── utils/
│ └── dateFormat.js
├── .env
├── .gitignore
├── app.js
├── package.json
├── README.md
```
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License.