Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gudzsv/nodejs-hw-mongodb
nodejs-hw-mongodb
https://github.com/gudzsv/nodejs-hw-mongodb
Last synced: about 1 month ago
JSON representation
nodejs-hw-mongodb
- Host: GitHub
- URL: https://github.com/gudzsv/nodejs-hw-mongodb
- Owner: gudzsv
- License: mit
- Created: 2024-07-24T19:08:05.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T22:08:11.000Z (4 months ago)
- Last Synced: 2024-08-30T11:14:25.281Z (4 months ago)
- Language: JavaScript
- Size: 1 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backend Application for Managing Contacts and Users
## Overview
This project is a fully-featured backend application designed to manage contacts and users. It includes functionality for user session management, password reset, and email notification. The application also supports adding user photos, which are stored in Cloudinary, with the image URLs saved in MongoDB.
## Features
- **User Management**:
- Register, login, and manage user sessions with JWT tokens.
- Password reset functionality with a reset link sent via email.
- **Contacts Management**:
- Create, update, and manage contacts.
- Upload user photos, which are stored in Cloudinary with URLs saved in MongoDB.
- **API Documentation**:
- RESTful API documentation available through Swagger.
## Technology Stack
- **Node.js**: Server-side runtime environment.
- **Express.js**: Web framework for building RESTful APIs.
- **MongoDB**: NoSQL database for storing user data, contacts, and session information.
- **Handlebars**: Template engine for dynamic email templates.
- **Swagger**: API documentation tool.
- **bcrypt**: Library for hashing and comparing passwords.
- **JWT (JSON Web Tokens)**: Secure method for transmitting user session data.
- **Multer**: Middleware for handling `multipart/form-data`, used for uploading files.
- **Nodemailer**: Node.js module for sending emails.
- **Cloudinary**: Cloud-based service for storing and managing images.
## Installation
### Prerequisites
- Node.js
- MongoDB
- Cloudinary Account (for image storage)
### Steps to Set Up
1. **Clone the repository:**
```bash
git clone https://github.com/gudzsv/nodejs-hw-mongodb.git
cd your-repository
```
2. **Install dependencies:**
```bash
npm install
```
3. **Set up environment variables:**
Create a .env file in the root of your project and add the following:
```env
APP_DOMAIN=
APP_PORT=
MONGODB_USER=
MONGODB_PASSWORD=
MONGODB_URL=
MONGODB_DB=
SALT=
SMTP_HOST=
SMTP_PORT=
SMTP_USER=
SMTP_PASSWORD=
SMTP_FROM=
CLOUDINARY_CLOUD_NAME=
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=
JWT_SECRET=
```
4. **Run the application:**
```bash
npm run dev
```
5. **Access the API Documentation:**
After running the application, you can access the Swagger API documentation at:
```bash
local:
http://localhost:8080/api-docs
on server:
https://nodejs-hw-mongodb-n71x.onrender.com/api-docs/
```
## Usage
**User Registration and Authentication**
- Users can register with an email and password and name.
- Upon registration, a token is issued for session management.
- Users can reset their password by receiving a reset link via email.
**Contact Management**
- Users can create and manage their contacts.
- Each contact can have an associated photo, which is uploaded via the API and stored in Cloudinary.
- The URL to the photo is stored in MongoDB for easy retrieval.
**API Endpoints**
Here are some of the key API endpoints:
- User Authentication
- POST /auth/register: Register a new user.
- POST /auth/login: Login and receive a JWT token.
- POST /auth/refresh: Refresh session accessToken
- POST /auth/logout: Logout clear cookies and remove session from database
- POST /auth/send-reset-email: Request a password reset link.
- POST /auth/reset-pwd: Reset user password
- Contacts
- GET /contacts: Get all contacts.
- GET /contacts/{contactId}: Get contact by id
- POST /contacts: Create a new contact with an optional photo.
- PATCH /contacts/{contactId}: Update contacts parameters
- DELETE /contacts/{contactId}: Delete an existing Contact
For a full list of endpoints and their details, refer to the [Swagger documentation](https://nodejs-hw-mongodb-n71x.onrender.com/api-docs/).