Link-Bridge-Api

Link-Bridge-Api is the RESTful API for the LinkBridge React app, providing seamless connection management and link aggregation functionalities.

This api is deployed on Cyclic.

Fun Fact 🤓

Note

I created this project entirely using my Android Phone with apps: Acode & Termux.

Features

🔒 User Authentication: Secure user authentication using JWT tokens.
🖼️ Profile Customization: Users can customize their profiles, including updating their bio and profile picture.
🔗 Link Management: Add, update, and delete custom links for your LinkTree profile.
🌐 Social Links Integration: Easily add and manage social media links to your profile.
🔑 Forgot Password: Password recovery functionality for users who forget their passwords.

Live Demo 🎉

https://link-bridge.vercel.app

Installation

Clone the repository:

git clone https://github.com/fazle-rabbi-dev/Link-Bridge-Api

Navigate to the project directory:
```
cd Link-Bridge-Api
```
Install dependencies:
```
npm install
```

Configuration

Create a .env file in the root directory and define the following environment variables:

 MONGODB_URI=
 JWT_SECRET=
 
 ACCESS_TOKEN_SECRET=
 REFRESH_TOKEN_SECRET=
 
 ACCESS_TOKEN_EXPIRY="1d"
 REFRESH_TOKEN_EXPIRY="10d"
 
 CLOUDINARY_CLOUD_NAME=
 CLOUDINARY_API_KEY=
 CLOUDINARY_API_SECRET=
 
 GMAIL_USERNAME=
 GMAIL_PASSWORD=<Write your app password, which you can obtain by enabling two-factor authentication in your Gmail account.>

Usage

Start the server:
```
npm run dev
```
The API will be accessible at http://localhost:5000.

API Endpoints

/api/users: User authentication & User profile management endpoints.
/api/links: Link management endpoints.

Project Structure

.
├── nodemon.json              // Configuration file for nodemon
├── package-lock.json
├── package.json
├── public                    // Contains publicly accessible files
├── README.md
├── src
│   ├── app.js
│   ├── controllers            // Contains controller logic for handling HTTP requests
│   │   ├── userController.js // Controller for user-related operations
│   ├── database               // Database-related logic and database connection setup
│   │   ├── User.js           // Database operations related to user management
│   │   └── db-connect.js     // Database connection setup
│   ├── index.js               // Entry point of the application
│   ├── middlewares            // Middleware functions for request processing
│   │   ├── authMiddleware.js       // Authentication middleware
│   │   ├── multerMiddleware.js     // Middleware for handling file uploads (if applicable)
│   │   ├── notFoundErrorHandler.js // Middleware for handling 404 errors
│   │   └── otherErrorHandler.js    // Other error handling middleware
│   ├── models                 // Database models/schema definitions
│   │   └── UserModel.js      // User model definition
│   ├── routes                 // Route definitions for different API endpoints
│   │   ├── index.js          // Main router file
│   │   ├── userRoutes.js     // Routes related to user management
│   ├── services               // Service layer containing business logic
│   │   ├── userService.js    // Service functions for user-related operations
│   └── utils                  // Utility functions and helper modules
│       ├── ApiError.js        // Custom API error handler
│       ├── ApiResponse.js    // Response format utility
│       ├── CustomError.js    // Custom error class definition
│       ├── cloudinary.js     // Cloudinary integration for file storage (if applicable)
│       ├── constants.js      // Constant values used throughout the application
│       ├── corsOptions.js    // CORS configuration options
│       ├── emailTemplates.js // Email template generation functions
│       ├── helpers.js        // Miscellaneous helper functions
│       ├── limiter.js        // Rate limiting configuration
│       └── sendEmail.js      // Email sending functionality
└── swagger.json              // Swagger/OpenAPI specification file