Skip to content

README.md

Latest commit

 

History

History
164 lines (120 loc) · 3.17 KB

README.md

File metadata and controls

164 lines (120 loc) · 3.17 KB

🚆 RailPulse – Train Finder & Backend API

Java Spring Boot MySQL Maven REST API Open Source

📌 About The Project

RailPulse is a backend application built using Java & Spring Boot that provides fast, reliable, and structured train-related data through RESTful APIs.
This project follows clean backend architecture and real-world development practices.

✨ Features

  • 🔍 Search trains between source & destination
  • 🕒 Train schedules and timings
  • 🚉 Station-wise train lookup
  • ⚙️ RESTful API architecture
  • 🗄️ MySQL database integration
  • 🛡️ Clean & scalable backend code

🛠️ Tech Stack

  • Java
  • Spring Boot
  • MySQL
  • Hibernate / JPA
  • Maven
  • REST API
  • Git & GitHub

📂 Project Structure

RailPulse/
│
├── src/
│   ├── main/
│   │   ├── java/com/railpulse/
│   │   │   ├── controller/
│   │   │   ├── service/
│   │   │   ├── repository/
│   │   │   └── model/
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│
├── pom.xml
└── README.md

🚀 Getting Started

✅ Prerequisites

  • Java 17+
  • Maven
  • MySQL
  • Git

🔧 Installation & Run

git clone https://github.com/gitKeshav11/RailPulse.git
cd RailPulse
mvn clean install
mvn spring-boot:run

🌐 API Documentation

Base URL

http://localhost:8080/api

📍 Get All Trains

GET /trains

📍 Get Train By ID

GET /trains/{id}

📍 Search Trains

GET /trains/search?source=Delhi&destination=Mumbai

📍 Add New Train

POST /trains

Request Body

{
  "trainName": "Rajdhani Express",
  "source": "Delhi",
  "destination": "Mumbai",
  "departureTime": "16:30"
}

📸 Screenshots & Demo

🔹 API Testing (Postman)

Postman Screenshot

🔹 Database Records

Database Screenshot

🎥 Demo GIF

RailPulse Demo

🚀 Future Enhancements

  • 🔐 JWT Authentication
  • 📊 Admin Dashboard
  • 📱 Frontend Integration
  • ☁️ Cloud Deployment

🤝 Contributing

Contributions are welcome!
Fork the repository and submit a pull request.

👨‍💻 Author

Keshav Upadhyay
Java Backend Developer | Spring Boot | REST APIs

🔗 GitHub: https://github.com/gitKeshav11
🔗 LinkedIn: https://www.linkedin.com/in/keshavupadhyayje/

⭐ Support

If you like this project, please give it a ⭐ on GitHub.
Your support motivates me to build more projects 🚀