Train Management System – Setup and Run Guide

Prerequisites

Make sure you have the following installed:

Python 3.x
pip (Python package installer)
Git (for cloning the repository)
Postman (optional, for API testing)

Steps to Run the Project Locally

1. Clone the Repository

Open a terminal/command prompt and run:

git clone https://github.com/SheikhSaif2305/Train_Management_Sys.git
cd Train_Management_Sys

2. Create and Activate Virtual Environment

This ensures your dependencies don’t conflict with other projects.

# Create a virtual environment (Windows)
python -m venv venv

# Activate the virtual environment
venv\Scripts\activate

3. Install Dependencies

All required dependencies are listed in requirements.txt. Use terminal to Install them:

pip install -r requirements.txt

4. Setting Up the Database

Start the SQL Server: Ensure that your MySQL server is running. Use terminal or MySQL Workbench.
Create a Database: Before running the application, create a database for the project. You can use the following SQL command:
```
CREATE DATABASE your_database_name;
```
Replace your_database_name with your desired database name.

5. Set Up Environment Variables

Create a .env file in the project directory. For example(replace the value where needed):

MYSQL_HOST=localhost
MYSQL_USER=root
MYSQL_PASSWORD=your_password
MYSQL_DB=your_database_name
JWT_SECRET_KEY=edf766ea63a4cc7f22b5310ade5e88339ab316ab6a146b5a0086c46029cdd4c0

6. Run the Application

Go to the project directory, ensure you have activated your virtual environment, and then in your terminal, use:

python app.py

7. Access the Application

By default, the app runs on http://127.0.0.1:5000.
Open your browser or Postman to access API routes.

Database Schema Overview

All database schemas for the project are defined in the models/__init__.py file. When the application starts by running app.py, this script executes, automatically creating all necessary tables needed for the project. This setup ensures that the database is ready to handle user registration, station management, train schedules, ticketing, and wallet transactions, fulfilling the project's requirements seamlessly.

Each table, including users, stations, trains, train_stops, tickets, and transactions, is created if it does not already exist, maintaining the integrity of the database throughout the application's lifecycle.

API Documentation

Overview

This project offers a set of RESTful APIs for managing trains, stations, tickets, and wallets. The system utilizes JWT authentication for security and interacts with a MySQL database.

--

Authentication

Authorization Header: Required for protected routes

Authorization: Bearer <your_token>

Make sure to include the JWT token in the Authorization header for every secured endpoint.

Endpoints

1. User Authentication

POST /register

Description: Register a new user.
Method: POST
Path: /register
Request Header:

Content-Type: application/json

Request Body:

{
  "email": "[email protected]",
  "password": "password123"
}

Response:

201 Created

{
  "message": "User registered successfully"
}

409 Conflict
```
{
  "message": "User already exists"
}
```

POST /login

Description: Authenticate a user and receive a JWT token.
Method: POST
Path: /login
Request Header:

Content-Type: application/json

Request Body:

{
  "email": "[email protected]",
  "password": "password123"
}

Response:

200 OK
```
{
  "access_token": "<jwt_token>"
}
```
401 Unauthorized
```
{
  "message": "Invalid credentials"
}
```

2. Station Management

POST /addstations

Description: Add a new train station.
Method: POST
Path: /addstations
Request Header:

Authorization: Bearer <your_token>
Content-Type: application/json

Request Body:

{
  "name": "Station A",
  "location": "City A"
}

Response:

201 Created

{
  "message": "Station added successfully"
}

PUT /updatestation/<station_id>

Description: Update an existing station.
Method: PUT
Path: /updatestation/<station_id>
Request Header:

Authorization: Bearer <your_token>
Content-Type: application/json

Request Body:

{
  "name": "Updated Station",
  "location": "Updated City"
}

Response:

200 OK

{
  "message": "Station <station_id> updated successfully"
}

GET /stations

Description: Retrieve all stations.
Method: GET
Path: /stations
Response:

200 OK

[
  {"id": 1, "name": "Station A", "location": "City A"},
  {"id": 2, "name": "Station B", "location": "City B"}
]

3. Train Management

POST /trains

Description: Create a new train with stops.
Method: POST
Path: /trains
Request Header:

Authorization: Bearer <your_token>
Content-Type: application/json

Request Body:

{
  "name": "Express Train",
  "description": "Fast train from A to B",
  "stops": [
    {"station_id": 1, "arrival_time": "08:00", "departure_time": "08:15"},
    {"station_id": 2, "arrival_time": "09:00", "departure_time": "09:15"}
  ]
}

Response:

201 Created

{
  "message": "Train and stops added successfully"
}

PUT /trains/<train_id>/stops/<stop_id>

Description: Update a stop's details for a specific train.
Method: PUT
Path: /trains/<train_id>/stops/<stop_id>
Request Header:

Authorization: Bearer <your_token>
Content-Type: application/json

Request Body:

{
  "arrival_time": "10:00",
  "departure_time": "10:15"
}

Response:

200 OK

{
  "message": "Train stop updated successfully"
}

400 Bad Request

{
  "message": "No valid fields provided for update"
}

GET /trains

Description: Retrieve all train schedules.
Method: GET
Path: /trains
Response:

200 OK

[
  {
    "id": 1,
    "name": "Express Train",
    "description": "Fast train from A to B",
    "stops": [
      {"station_id": 1, "station_name": "Station A", "arrival_time": "08:00", "departure_time": "08:15"},
      {"station_id": 2, "station_name": "Station B", "arrival_time": "09:00", "departure_time": "09:15"}
    ]
  }
]

4. Ticket Management

POST /tickets/purchase

Description: Purchase a ticket.
Method: POST
Path: /tickets/purchase
Request Header:

Authorization: Bearer <your_token>
Content-Type: application/json

Request Body:

{
  "train_id": 1,
  "from_station": "Station A",
  "to_station": "Station B",
  "price": 200
}

Response:

201 Created

{
  "message": "Ticket purchased successfully"
}

400 Bad Request
```
{
  "message": "Insufficient funds"
}
```

5. Wallet Management

POST /wallet/add

Description: Add funds to the user’s wallet.
Method: POST
Path: /wallet/add
Request Header:

Authorization: Bearer <your_token>
Content-Type: application/json

Request Body:

{
  "amount": 500
}

Response:

200 OK

{
  "message": "Funds added successfully"
}

GET /wallet/history

Description: Retrieve transaction history.
Method: GET
Path: /wallet/history
Request Header:

Authorization: Bearer <your_token>

Response:

200 OK

[
  {"amount": 500, "type": "add", "timestamp": "2024-10-18 12:00:00"},
  {"amount": 200, "type": "deduct", "timestamp": "2024-10-18 12:15:00"}
]

Error Codes

Status Code	Description
200 OK	Request completed successfully
201 Created	Resource created successfully
400 Bad Request	Invalid data or missing fields
401 Unauthorized	Authentication failed
409 Conflict	Resource already exists

Project Summary

This project implements a comprehensive train and ticket management system with user authentication, wallet integration, and secure operations. Below is a mapping of the implemented routes to the provided criteria, demonstrating that all requirements have been successfully fulfilled.

1. User Management

Criteria:

Implement user registration and login.
Use JWT for secure authentication and authorization.
Hash passwords before storing them in the database.

Implemented Routes:

POST /register: Registers new users with hashed passwords.
POST /login: Authenticates users and provides a JWT token for secure access.
JWT Authentication: Secured endpoints require the token for access (@jwt_required decorator).

2. Station Management

Criteria:

Implement endpoints for creating, updating, and retrieving station information.
Ensure data integrity and proper validation.

Implemented Routes:

POST /addstations: Adds a new station to the system.
PUT /updatestation/<station_id>: Updates existing station information.
GET /stations: Retrieves all stations with relevant data.

3. Train Management

Criteria:

Implement endpoints for creating, updating, and retrieving train schedules and stops.
Ensure that each train has a list of stops with accurate timings.

Implemented Routes:

POST /trains: Creates new trains with their stops and schedules.
PUT /trains/<train_id>/stops/<stop_id>: Updates train stops with new arrival or departure times.
GET /trains: Retrieves train schedules with detailed stop information.

4. Wallet Integration

Criteria:

Implement endpoints for adding funds to user wallets.
Ensure wallet balance updates and transaction history are maintained.

Implemented Routes:

POST /wallet/add: Adds funds to the user’s wallet, ensuring wallet balance updates.
GET /wallet/history: Retrieves the transaction history to maintain transparency and tracking.

5. Ticketing System

Criteria:

Implement endpoints for purchasing tickets using wallet balance.
Calculate the fare based on train stops and update the wallet balance accordingly.

Implemented Routes:

POST /tickets/purchase: Allows users to purchase tickets. Wallet balance is deducted, and fare is calculated based on the selected stops.

6. Middleware for Authentication

Criteria:

Create middleware (or decorators) to protect routes and ensure only authenticated users can access them.

Implementation:

All sensitive routes use JWT-based authentication with the @jwt_required decorator to ensure only authenticated users can access protected endpoints (e.g., wallet transactions, ticket purchases).

Conclusion

The project meets all the provided criteria by implementing secure user management, accurate station and train scheduling, wallet integration, and a ticketing system with fare calculation. Each route is mapped to fulfill specific requirements, with proper validation, data integrity, and secure operations using JWT. This ensures the project is robust, secure, and functional.

- Sheikh Saif Simran

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
models		models
routes		routes
services		services
.gitignore		.gitignore
README.md		README.md
app.py		app.py
config.py		config.py
requirements.txt		requirements.txt

SheikhSaif2305/Train_Management_Sys

Folders and files

Latest commit

History

Repository files navigation

Train Management System – Setup and Run Guide

Prerequisites

Steps to Run the Project Locally

1. Clone the Repository

2. Create and Activate Virtual Environment

3. Install Dependencies

4. Setting Up the Database

5. Set Up Environment Variables

6. Run the Application

7. Access the Application

Database Schema Overview

API Documentation

Overview

Authentication

Endpoints

1. User Authentication

POST /register

POST /login

2. Station Management

POST /addstations

PUT /updatestation/<station_id>

GET /stations

3. Train Management

POST /trains

PUT /trains/<train_id>/stops/<stop_id>

GET /trains

4. Ticket Management

POST /tickets/purchase

5. Wallet Management

POST /wallet/add

GET /wallet/history

Error Codes

Project Summary

1. User Management

2. Station Management

3. Train Management

4. Wallet Integration

5. Ticketing System

6. Middleware for Authentication

Conclusion

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages