https://github.com/tobidoks/alertify
This project allows users to manage tasks, track their progress, and manage user profiles with secure authentication.
https://github.com/tobidoks/alertify
alerting docker-compose jwt-authentication maven-pom postgresql spring-boot
Last synced: about 2 months ago
JSON representation
This project allows users to manage tasks, track their progress, and manage user profiles with secure authentication.
- Host: GitHub
- URL: https://github.com/tobidoks/alertify
- Owner: tobidoks
- Created: 2025-02-09T03:52:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-09T13:26:18.000Z (over 1 year ago)
- Last Synced: 2025-04-06T04:19:28.095Z (about 1 year ago)
- Topics: alerting, docker-compose, jwt-authentication, maven-pom, postgresql, spring-boot
- Language: Java
- Homepage: https://github.com/tobidoks/alertify
- Size: 22.5 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alertify Project
---
## Overview
Alertify is a powerful task management and user authentication system designed using Java, Spring Boot, and PostgreSQL. This project allows users to manage tasks, track their progress, and manage user profiles with secure authentication. It's built to provide an intuitive API for task management, enabling easy integration and usage.
---
## Prerequisites
Ensure you have the following installed:
- **Java 23**
- **Maven 4.x**
- **Docker**
---
## Setup Instructions
### 1. Clone the Repository
Clone the repository from GitHub to your local machine:
```bash
git clone https://github.com/tobidoks/alertify.git
cd alertify
```
---
### 2. Run Docker-Compose to Start Postgres Container
Ensure Docker is running on your machine. Then, execute the following command to start the PostgresDB container:
```bash
docker-compose up -d
```
This will pull the Postgres Docker image (if not already present) and start the container in detached mode.
---
### 3. Build the Project
Run the following command to build the project using Maven:
```bash
mvn clean install
```
This will compile the source code, run tests, and create a build artifact.
---
### 4. Configure Environment Variables
1. Add the necessary environment variables to the Spring Boot application configuration
2. Add an active profile and set it to `local`
---
### 5. Run the Project in Your IDE
1. Open the project in your IDE
2. Run the `AlertifyApplication` class to start the Spring Boot application.
---
## API Documentation
Once the application starts, it will be accessible at:
```
http://localhost:9090/swagger-ui/index.html
```
Use this URL to explore the API endpoints with Swagger UI.
The Swagger UI provides a graphical interface to explore and test the API endpoints.
---
## Technologies Used
- **Java 23**: Programming language for application logic.
- **Spring Boot**: Framework for building the backend application.
- **PostgresDB**: PostgresSQL database for data persistence.
- **Maven**: Build and dependency management tool.
- **Docker**: Containerization platform for running PostgresDB.
- **Swagger**: Tool for API documentation and testing.
---