Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Yurben-bit/Sistema-de-Administraci-n-Escolar-Backend/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Before you begin, ensure you have the following installed on your system:
1

Java Development Kit (JDK) 8

The project requires Java 8. Download and install from Oracle or use OpenJDK.Verify installation:
java -version
# Should output: java version "1.8.0_xxx"
2

Maven 3.6+

While the project includes Maven Wrapper, having Maven installed globally is recommended.
mvn -version
# Should output: Apache Maven 3.6.x or higher
The project includes Maven Wrapper (mvnw and mvnw.cmd), so Maven installation is optional.
3

MySQL 8.0+

Install MySQL Server 8.0 or higher for production-like development.
4

Git

For cloning the repository and version control.
git --version

​
IDE Recommendations

Choose one of these IDEs for the best development experience:
  • Community Edition (free) or Ultimate Edition
  • Built-in Spring Boot support
  • Excellent Maven integration
  • Best Java debugging experience

​
Eclipse IDE

  • Install Spring Tools 4 plugin for Spring Boot support
  • Free and open source
  • Good Maven integration via M2Eclipse

​
Visual Studio Code

  • Install extensions:
    • Spring Boot Extension Pack
    • Extension Pack for Java
    • Maven for Java
  • Lightweight and fast

​
Cloning the Repository

Clone the EduTec Backend repository to your local machine: 
git clone https://github.com/Yurben-bit/Sistema-de-Administraci-n-Escolar-Backend.git
cd Sistema-de-Administraci-n-Escolar-Backend

​
Project Structure

The project follows a standard Spring Boot / Maven structure: 
edutec-backend/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/tecmilenio/edutec/
│   │   │       ├── EdutecApplication.java    # Main application class
│   │   │       ├── controller/               # REST API controllers
│   │   │       │   └── AuthController.java
│   │   │       ├── dto/                      # Data Transfer Objects
│   │   │       │   └── LoginRequest.java
│   │   │       ├── model/                    # JPA entities
│   │   │       └── security/                 # Security & JWT configuration
│   │   │           └── JwtService.java
│   │   └── resources/
│   │       ├── application.properties        # Application configuration
│   │       └── static/                       # Static resources
│   └── test/                                 # Test classes
├── mvnw                                      # Maven Wrapper (Unix)
├── mvnw.cmd                                  # Maven Wrapper (Windows)
├── pom.xml                                   # Maven configuration
└── README.md

​
Key Directories

  • controller/: REST API endpoints and request handlers
  • dto/: Data Transfer Objects for API requests/responses
  • model/: JPA entity classes mapped to database tables
  • security/: Authentication, authorization, and JWT token handling
  • resources/: Configuration files and static assets

​
Installing Dependencies

Install all project dependencies using Maven Wrapper: 
./mvnw clean install
This command will:
  • Download all dependencies specified in pom.xml
  • Compile the source code
  • Run tests
  • Package the application
Use ./mvnw clean install -DskipTests to skip tests during the initial setup for faster installation.

​
Key Dependencies

The project includes the following major dependencies:
DependencyVersionPurpose
Spring Boot2.6.6Core framework
Spring Data JPA2.6.6Database persistence
MySQL Connector8.0.19MySQL database driver
H2 DatabaseRuntimeIn-memory database for development
JWT (jjwt)0.11.5JSON Web Token authentication
LombokLatestReduce boilerplate code
Hibernate Search5.11.8Full-text search capabilities
Spring Boot DevToolsRuntimeHot reload during development
Springfox Swagger2.4.0API documentation

​
Verifying the Setup

After installation, verify your setup: 
# Check Maven Wrapper is working
./mvnw -version

# Verify dependencies are downloaded
./mvnw dependency:tree

# Compile the project
./mvnw compile
If all commands succeed without errors, your development environment is ready!

​
Next Steps

Configuration

Configure database connections and environment variables

Running Locally

Start the application and test endpoints

Build docs developers (and LLMs) love

Get started for freeTalk to us