Skip to content

Abdumalik-ProDev/Indigo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Indigo

Indigo is a full Java-based web application designed to simplify operations in kindergartens and early education centers. It includes features like student management, event scheduling, parent communication, and resource control β€” all wrapped in a clean, intuitive UI based on a detailed Figma design.

✨ Key Features

βœ… Role-based user authentication

πŸ§’ Student information and attendance management

πŸ—“ Event scheduling and activity tracking

πŸ“’ Messaging and notifications for parents and teachers

πŸ“š Resource and material allocation

πŸ“‘ Swagger UI for testing and documenting APIs

πŸ“Š Admin dashboard (planned)

🎨 Figma Design Take a deep dive into the UI/UX vision:

πŸ”— Figma Design – https://www.figma.com/design/egY90HlOAiLF53TaTrkM9W/%D0%B4%D0%B5%D1%82%D1%81%D0%B0%D0%B4?node-id=19-7499&t=9CERIDw8BZIpuzkB-0

πŸ§ͺ Tech Stack Layer Tech Backend Java 17, Spring Boot, Spring Data JPA Frontend Thymeleaf, HTML5, CSS3, JavaScript Database PostgreSQL API Docs Swagger UI (Springfox/OpenAPI) Build Tool Maven VCS Git

πŸ“ Project Structure

Indigo/ β”œβ”€β”€ src/ β”‚ β”œβ”€β”€ main/ β”‚ β”‚ β”œβ”€β”€ java/ β”‚ β”‚ β”‚ └── abdumalik/ β”‚ β”‚ β”‚ └── dev/ β”‚ β”‚ β”‚ └── indigo/ β”‚ β”‚ β”‚ β”œβ”€β”€ controller/ β”‚ β”‚ β”‚ β”œβ”€β”€ dto/ β”‚ β”‚ β”‚ β”œβ”€β”€ model/ β”‚ β”‚ β”‚ β”œβ”€β”€ repository/ β”‚ β”‚ β”‚ β”œβ”€β”€ security/ β”‚ β”‚ β”‚ β”œβ”€β”€ service/ β”‚ β”‚ β”‚ └── IndigoApplication.java β”‚ β”‚ └── resources/ β”‚ β”‚ β”œβ”€β”€ static/ β”‚ β”‚ β”œβ”€β”€ templates/ β”‚ β”‚ └── application.properties β”œβ”€β”€ pom.xml └── README.md

βš™οΈ Getting Started Prerequisites Java 17+

Maven 3.8+

PostgreSQL 12+

Internet connection for Maven dependencies

🧰 Setup Instructions

Clone the Repository

git clone https://github.com/Abdumalik-Java/Indigo.git cd Indigo Configure PostgreSQL

Create a database:

CREATE DATABASE indigo; Update src/main/resources/application.properties:

spring.datasource.url=jdbc:postgresql://localhost:5432/indigo spring.datasource.username=postgres spring.datasource.password=root spring.jpa.hibernate.ddl-auto=create

Run the Application

mvn spring-boot:run Access

Main app: http://localhost:8080

Swagger UI: http://localhost:8080/swagger-ui.html

πŸ§ͺ Testing

mvn test Unit tests and service layer tests are under development.

🧾 API Documentation

With Swagger UI integrated, all RESTful endpoints are auto-documented and testable at:

πŸ‘‰ http://localhost:8080/swagger-ui.html

πŸ“Œ Roadmap

Backend CRUD endpoints

Swagger integration

Role-based access control (RBAC)

Full admin panel

Responsive UI with Tailwind or Bootstrap

Email/notification system

πŸ‘¨β€πŸ’» Abdumalik Baxtiyorov - Abdumalik-Java

πŸ“„ License This project is licensed under the MIT License. See the LICENSE file for more info.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages