Indian-Rail-Api

A simple rest api for Indian Railway data for personal projects which allowe to GetTrainInformation,GetRoute,GetTrainOnDate,GetTrainBtwStations

Technologies Used

1. Nodejs
2. NPM Package: express
3. NPM Package: user-agents

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to get a copy of the project you will require you to have Node.js (v14+) and the NPM package manager installed. If you don't have it, you can download the latest version of Node.js from the official website which also installs the NPM package manager by default.

Installation

Open the terminal in the folder in which you wish to clone the repository and enter the following command:

git clone https://github.com/AniCrad/indian-rail-api.git .

Install all the NPM packages:

npm i

In order to run the server:

npm run start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/YourAmazingFeature)
3. Add Your Changes (git add .)
4. Commit your Changes (npm run commit)
5. Push to the Branch (git push origin feature/YourAmazingFeature)
6. Open a Pull Request

Note : only use npm run commit while commiting and select your tag whatever you done and then push it.

⚫Contributors

• Dojeto