Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d0ugur4su/reminder
The Reminder project consists of frontend (Angular), backend (Java Spring Boot), and associated microservices for handling reminder management tasks. It utilizes cloud services (AWS) for deployment and MongoDB for data persistence.
https://github.com/d0ugur4su/reminder
angular api-gateway asyncapi aws docker hexagonal-architecture java kubernetes microservices-architecture mongodb spring-boot swagger
Last synced: about 1 month ago
JSON representation
The Reminder project consists of frontend (Angular), backend (Java Spring Boot), and associated microservices for handling reminder management tasks. It utilizes cloud services (AWS) for deployment and MongoDB for data persistence.
- Host: GitHub
- URL: https://github.com/d0ugur4su/reminder
- Owner: D0UGUR4SU
- Created: 2024-04-16T03:14:49.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-18T03:25:55.000Z (10 months ago)
- Last Synced: 2024-11-13T23:32:16.154Z (3 months ago)
- Topics: angular, api-gateway, asyncapi, aws, docker, hexagonal-architecture, java, kubernetes, microservices-architecture, mongodb, spring-boot, swagger
- Language: Java
- Homepage:
- Size: 521 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Reminder
This repository contains the Reminder project, which implements a reminder management
system using a microservices architecture.
## 💻 Overview
The Reminder project consists of frontend (Angular), backend (Java Spring Boot),
and associated microservices for handling reminder management tasks.
It utilizes cloud services (AWS) for deployment and MongoDB for data persistence.
---
## 🛠 Installation
To run the project locally, follow these steps:
Clone the repository:
```bash
git clone https://github.com/D4GUR4SU/reminder.git
```
Backend Setup:
Navigate to the backend directory:
```bash
cd reminder/backend
```
Install dependencies:
```bash
mvn clean install
```
Start the backend server:
```bash
mvn spring-boot:run
```
Frontend Setup:
Navigate to the frontend directory:
```bash
cd reminder/frontend
```
Install dependencies:
```bash
npm install
```
Start the frontend server:
```bash
npm start
```
Access the Application:
Open your browser and navigate to ```http://localhost:4200```. to access the Angular frontend.
---
## 🧾 API Documentation
The API endpoints are documented using Swagger (OpenAPI). You can find the Swagger contract
in the docs/swagger directory.
---
# 🗂️ Folder Structure
backend: Contains the Java Spring Boot backend application.
frontend: Contains the Angular frontend application.
docs: Contains documentation related to the project.
docs/diagrams: Architecture diagrams (context, container, component).
docs/swagger: Swagger (OpenAPI) contract for the API.
---
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:
Fork the repository.
Create a new branch
```git checkout -b feature/my-feature```.
Commit your changes
```git commit -am 'Add new feature'```.
Push to the branch
```git push origin feature/my-feature```.
Create a new Pull Request.
---
## License
This project is licensed under the MIT License.
---
## 👨🏻💻 Author
Made by Douglas Souza 👋🏽 Get in touch!
[](https://www.linkedin.com/in/dagurasujava/)
---
## README versions
[English 🇺🇸](./README.md)