https://github.com/carpodok/node-blog-app
Web Blog API project built with Node.js
https://github.com/carpodok/node-blog-app
blog-app docker-compose expressjs jwt-authentication mongodb nodejs
Last synced: 8 months ago
JSON representation
Web Blog API project built with Node.js
- Host: GitHub
- URL: https://github.com/carpodok/node-blog-app
- Owner: carpodok
- License: mit
- Created: 2024-08-22T22:47:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-11T16:24:15.000Z (about 1 year ago)
- Last Synced: 2025-01-11T04:35:08.410Z (9 months ago)
- Topics: blog-app, docker-compose, expressjs, jwt-authentication, mongodb, nodejs
- Language: JavaScript
- Homepage:
- Size: 250 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Web Blog API
This project is a RESTful API for a Web Blog application built using Node.js. It provides a set of endpoints to manage users, posts, and comments. The API supports essential blog functionalities such as user authentication, creating and managing posts, and interacting with comments.
## Endpoints
Below is an overview of the available endpoints and their functionalities.
- ***To view the Swagger UI schema, navigate to `http://localhost:3000/api-docs` in your browser after running the server.***
- ***You can test these endpoints via this [Postman](https://www.postman.com/martian-meteor-939359/workspace/alitalhacoban-public-workspace/collection/18754010-ec536be0-b388-478e-baa5-b42ba97295b3?action=share&creator=18754010) collection***
## Technologies Used
- ***Node.js:*** Backend runtime environment.
- ***express.js:*** Web framework for Node.js.
- ***MongoDB:*** NoSQL database for storing user data.
- ***mongoose:*** ODM for MongoDB.
- ***express-validator:*** Server side validation for input fields
- ***bcrypt:*** Library for hashing passwords.
- ***JSON Web Tokens (JWT):*** Standard for creating secure access tokens.
- ***swagger-ui-express:*** Middleware to serve auto-generated Swagger API documentation in Express.js applications.
- ***swagger-jsdoc:*** Library to generate Swagger API documentation from JSDoc comments in your code.
- ***jest:*** Comprehensive testing of API endpoints using jest for unit tests and supertest for testing HTTP requests, ensuring reliable and consistent API functionality.
## Installation
1. Clone the repository
```bash
git clone https://github.com/carpodok/node-blog-app.git
```
2. Navigate to the project directory:
```bash
cd node-blog-app
```
3. Install required dependencies
```bash
npm install
```
## Configuration
1. Creat a `.env` file on the root of the project and add the following environment variables
```
PORT=3000
MONGODB_URL=your_mongodb_uri
JWT_SECRET=your_jwt_secret
```
## Running the Application
1. To start the server, run the following command on the root of the project path;
```
npm start
```
For the development purpose;
```
npm run dev
```
2. The application will be running on `http://localhost:3000`
## Running the Application with Docker
You can also run this application using Docker
1. Ensure Docker and Docker Compose are installed. If not, follow the [official Docker installation guide](https://docs.docker.com/engine/install/).
2. Build and run the applicaiton with Docker Compose:
```bash
docker-compose up
```
The application will be accessible at `http://localhost:3000`
3. ***Using a custom `.env` file:*** Ensure you have a `.env` file with the required environment variables (`PORT`, `MONGODB_URL`, `JWT_SECRET`), as it will be loaded automatically.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or suggestions.
## License
This project is licensed under the MIT License.