https://github.com/aanand058/fragments
A Cloud-Based Solution for Handling Different Types of Fragments
https://github.com/aanand058/fragments
api-server aws docker dynamodb ec2-instance javascript mircoservices unit-testing
Last synced: 3 months ago
JSON representation
A Cloud-Based Solution for Handling Different Types of Fragments
- Host: GitHub
- URL: https://github.com/aanand058/fragments
- Owner: Aanand058
- Created: 2024-01-09T05:27:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-23T14:48:24.000Z (over 1 year ago)
- Last Synced: 2025-07-14T18:44:41.644Z (about 1 year ago)
- Topics: api-server, aws, docker, dynamodb, ec2-instance, javascript, mircoservices, unit-testing
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fragments Microservice Development
A Cloud-Based Solution for Handling Different Types of Fragments
# **Fragments Microservices**
## **Project Overview**
Fragments Microservices is a cloud-native microservice-based application designed to store, retrieve, and manage user-generated content (fragments) such as text, JSON, and binary data (e.g., images). The application is built using **Node.js**, **Express.js**, and deployed on **AWS** services for scalability and security.
The system allows users to perform basic CRUD operations on their fragments, with authentication and authorization handled via **Amazon Cognito**. Data is stored in **AWS DynamoDB** for metadata and **Amazon S3** for binary content.
## **Live Demo**
Watch the demo video of the Fragments Microservices project on YouTube:
[]
---
## **Features**
- **User Authentication & Authorization:** Secured with **Amazon Cognito** to ensure only authenticated users can access the API.
- **Fragment Management:** Users can create, retrieve, update, and delete fragments (text, JSON, or images).
- **Scalable Data Storage:**
- Metadata is stored in **AWS DynamoDB**.
- Binary data is stored in **Amazon S3**.
- **Microservices Architecture:** The application is containerized using **Docker** and follows a microservices architecture for easy scalability.
- **Logging and Monitoring:** Integrated structured logging using **Pino** for efficient monitoring and error tracking.
- **Automated Testing:** Comprehensive unit and integration tests using **Jest** and **Supertest**.
---
## **Technologies Used**
- **Backend:** Node.js, Express.js
- **Authentication:** Amazon Cognito, Passport.js
- **Database:** Amazon DynamoDB (NoSQL)
- **Storage:** Amazon S3
- **CI/CD & Containers:** Docker, GitHub Actions, Docker Compose, LocalStack
- **Testing:** Jest, Supertest, Hurl
- **Logging:** Pino
- **Cloud Infrastructure:** AWS EC2, AWS Lambda, AWS SDK
- **Version Control:** Git, GitHub
---
## **Installation Instructions**
To set up this project locally:
1. **Clone the Repository:**
```bash
git clone https://github.com/Aanand058/fragments.git
```
2. **Install Dependencies:**
```bash
npm install
```
3. **Set Up Environment Variables:**
Create a `.env` file in the root directory with the following variables:
```bash
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
S3_BUCKET_NAME=
DYNAMODB_TABLE_NAME=
COGNITO_POOL_ID=
```
4. **Run the Application:**
```bash
npm start
```
5. **Run Tests:**
To run the test suite:
```bash
npm test
```
---
## **Usage**
Once the application is up and running, you can access the API endpoints for managing fragments:
- **Create Fragment:**
- POST `/v1/fragments`
- **Get Fragment:**
- GET `/v1/fragments/:id`
- **Update Fragment:**
- PUT `/v1/fragments/:id`
- **Delete Fragment:**
- DELETE `/v1/fragments/:id`
Refer to the Postman collection provided for detailed API usage.
---
## **API Documentation**
- **Base URL:** `http://localhost:8080/v1/fragments`
- **Authentication:** The API uses **Amazon Cognito** tokens for authentication. Include the `Authorization` header with a valid token for each request.
### **Endpoints:**
1. **POST /fragments**
- Create a new fragment (text, JSON, or binary data).
2. **GET /fragments/:id**
- Retrieve a specific fragment by its ID.
3. **PUT /fragments/:id**
- Update an existing fragment.
4. **DELETE /fragments/:id**
- Delete a fragment.
---
## **Testing**
The project includes unit tests and integration tests to ensure code quality and functionality. You can run tests using:
```bash
npm test
```
---
## **Contact**
For any inquiries or suggestions, feel free to reach out via:
- **GitHub:** [Aanand058](https://github.com/Aanand058)
- **Email:** [yamit058@gmail.com](mailto:yamit058@gmail.com)
---
This documentation is designed to provide an overview of your project, highlight the technologies used, and offer clear instructions on installation, usage, and contributing. Let me know if you need further customization!
## Package.json Scripts
- `npm start`: Start the server.
- `npm run lint`: Lint code using ESLint on .js files stored under src folder.
- `npm run dev`: Start the server in development mode with debug logs enabled.
- `npm run debug`: Start the server in debug mode for remote debugging with a debugger attached.
- `npm run test:watch`: Runs Jest in watch mode with a specific configuration file.
- `npm run test`: Runs Jest tests with a specific configuration file.
- `npm run coverage`: Runs Jest to generate test coverage reports.
## Usage
You can use tools like Postman or curl to interact with the API endpoints.