Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/venkateshramkumarg/train-ticket-backend

This RESTful API allows administrators to manage train bookings. It handles stations, trains, users, and bookings, enabling functionalities like creating trains with routes, booking seats, and user management.
https://github.com/venkateshramkumarg/train-ticket-backend

bun honojs postgresql prisma typescript

Last synced: 28 days ago
JSON representation

Host: GitHub
URL: https://github.com/venkateshramkumarg/train-ticket-backend
Owner: venkateshramkumarg
License: mit
Created: 2024-08-13T08:51:15.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-09-02T06:06:11.000Z (2 months ago)
Last Synced: 2024-09-25T18:29:04.014Z (about 1 month ago)
Topics: bun, honojs, postgresql, prisma, typescript
Language: TypeScript
Homepage:
Size: 21.5 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Train Ticket Booking System

Welcome to the Train Ticket Booking System. This application allows administrators to manage users, stations, trains, and bookings through a RESTful API.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Admin](#admin)
- [Stations](#stations)
- [Trains](#trains)
- [Users](#users)
- [Bookings](#bookings)
- [Environment Variables](#environment-variables)
- [License](#license)

## Installation

1. Clone the repository:
```sh
git clone https://github.com/venkateshramkumarg/ecommerce_backend.git
cd TrainTicket
```

2. Install dependencies:
```sh
npm install
```

3. Set up the database using Prisma:
```sh
npx prisma migrate dev
```

4. Start the application:
```sh
npm start
```

## Usage

The application runs on `http://localhost:3000/api`. You can use tools like Postman or curl to interact with the API.

## API Endpoints

### Admin

- **Create Admin**
```http
POST /api/admin/create/admin/new
```
**Request Body:**
```json
{
"user_name": "admin_name",
"password": "password",
"email": "[email protected]"
}
```

- **Delete Admin**
```http
DELETE /api/admin/delete/admin/:name
```

- **Update Admin**
```http
PUT /api/admin/update/admin/:name
```
**Request Body:**
```json
{
"password": "new_password",
"email": "[email protected]"
}
```

### Stations

- **Create Station**
```http
POST /api/stations/create/station/new
```
**Request Body:**
```json
{
"user_name": "admin_name",
"stationId": "station_id",
"stationName": "station_name"
}
```

- **Delete Station**
```http
DELETE /api/stations/delete/station/:id
```

- **Get Station by ID**
```http
GET /api/stations/stations/:id
```

### Trains

- **Create Train**
```http
POST /api/trains/create/train/new
```
**Request Body:**
```json
{
"user_name": "admin_name",
"trainNo": "train_number",
"trainName": "train_name",
"noOfSeatsAvailable": "number_of_seats",
"departureDate": "departure_date",
"stationIds": ["station_id1", "station_id2"]
}
```

- **Delete Train**
```http
DELETE /api/trains/delete/train/:number
```

### Users

- **Create User**
```http
POST /api/users/create/user/new
```
**Request Body:**
```json
{
"user_name": "user_name",
"password": "password",
"email": "[email protected]"
}
```

- **Delete User**
```http
DELETE /api/users/delete/user/:name
```

- **Update User**
```http
PUT /api/users/update/user/:name
```
**Request Body:**
```json
{
"password": "new_password",
"email": "[email protected]"
}
```

### Bookings

- **Create Booking**
```http
POST /api/bookings/create/booking/new
```
**Request Body:**
```json
{
"user_name": "user_name",
"trainNo": "train_number",
"seatNo": "seat_number"
}
```

- **Delete Booking**
```http
DELETE /api/bookings/delete/booking/:id
```

## Environment Variables

Create a [`.env`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2Fc%3A%2FVS%20CODE%2FNodeJS%2FTrainTicket%2FTrainTicket%2F.env%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D "c:\VS CODE\NodeJS\TrainTicket\TrainTicket\.env") file in the root directory and add the following environment variables: