Table of Contents
Follow these instructions to set up and run the project on your local machine.
-
Clone the Repository:
Clone the project repository to your local machine using Git:
git clone https://github.com/your-username/your-repo.git
-
To run the code:
npm install npm start| Library | Description |
|---|---|
cloudinary |
Used for image and video management. Cloudinary is a cloud-based solution for storing, managing, and delivering images and videos. It simplifies the process of handling media files in the application. |
dotenv |
Used for managing environment variables. Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env, making it easy to configure your application without hardcoding sensitive information. |
express |
Used for building the web application. Express is a popular web application framework for Node.js. It simplifies the development of web applications and APIs, providing a robust foundation for building routes and handling HTTP requests. |
express-fileupload |
Used for handling file uploads. Express File Upload is a middleware for handling file uploads in Express applications. It facilitates the processing of uploaded files and integrates seamlessly with Express routes. |
joi |
Used for request data validation. Joi is a powerful validation library for JavaScript. It is commonly used to validate incoming request data, ensuring that data is properly formatted and meets specific criteria before processing. |
mongoose |
Used for interacting with MongoDB. Mongoose is an Object Data Modeling (ODM) library for MongoDB and Node.js. It simplifies database interactions, providing a higher-level interface for working with MongoDB databases. |
nodemon |
Used for automatic server restarts during development. Nodemon is a utility that monitors changes in your Node.js application and automatically restarts the server. This is invaluable during development, as it saves time by eliminating the need to manually restart the server after code changes. |
Here are the available API endpoints with their descriptions, request methods, example API usage, and response descriptions.
| Endpoint | Description | Request Method | Example API | Response Description |
|---|---|---|---|---|
/ |
Home route | GET |
/ |
Returns a greeting message. |
/posts |
Create a new post and save it to the database | POST |
/posts |
Creates a new post and returns the saved post. |
/posts |
Get all the posts | GET |
/posts |
Returns a list of all posts. |
/search/posts |
Search posts by title and description | GET |
/search/posts?query=keyword |
Searches for posts matching the query keyword. |
/upload |
Upload an image | POST |
/upload |
Uploads an image and returns the image URL. |
- Endpoint:
/ - Description: This is the home route, which provides a simple greeting message.
- Request Method:
GET - Example API:
GET / - Response Description: Returns a greeting message.
- Endpoint:
/posts - Description: Create a new post and save it to the database.
- Request Method:
POST - Example API:
POST /posts - Response Description: Creates a new post and returns the saved post.
- Endpoint:
/posts - Description: Get all the posts stored in the database.
- Request Method:
GET - Example API:
GET /posts - Response Description: Returns a list of all posts.
- Endpoint:
/search/posts - Description: Search for posts using keywords found in the title and description.
- Request Method:
GET - Example API:
GET /search/posts?query=keyword - Response Description: Searches for posts matching the query keyword.
- Endpoint:
/upload - Description: Upload an image to the server or cloud storage (e.g., Cloudinary).
- Request Method:
POST - Example API:
POST /upload - Response Description: Uploads an image and returns the image URL.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent