Skip to content

kartikshukla17/vyomtracker-api

Repository files navigation

🚀 VyomTracker API

VyomTracker is an open-source REST API that provides structured and detailed information about ISRO's space missions, satellites, launch vehicles, and more. Built with Node.js, Express, and PostgreSQL, it serves as a reliable backend for developers and space enthusiasts alike.


🌌 Features

  • 🚀 Retrieve data on ISRO space missions
  • 🛰️ Access satellite details including purpose, launch info, and current status
  • 🛫 Explore Indian launch vehicles like PSLV, GSLV, and LVM3
  • 🔍 Searchable, filterable RESTful endpoints
  • 📐 Scalable backend architecture ready for frontend integration

🛠️ Tech Stack

  • Node.js with Express.js
  • PostgreSQL for data storage
  • Sequelize or Knex (depending on your implementation)
  • Swagger / Postman for API documentation (optional)

🚀 Getting Started

1. Clone the repository

git clone https://github.com/yourusername/vyomtracker.git
cd vyomtracker

2. Create a local .env from the .env.example:

cp .env.example .env

3. Set up PostgreSQL:

  1. Install PostgreSQL if you don't have it.
  2. Create a DB called vyomtracker:
     createdb vyomtracker
  3. Run the provided .sql file to populate tables.

4. Install dependencies:

npm install

5. Run the Server Locally

npm start
Server will start at http://localhost:5000
  1. Test Example Endpoint
GET http://localhost:5000/missions

📚 API Documentation You can explore the full API using the Postman collection:

👉 View Public Collection : https://www.postman.com/spaceflight-geologist/vyomtracker-api/collection/axink7u/vyomtracker-api?action=share&creator=30572112

📂 Project Structure

├── routes/
│ ├── mission.routes.js
│ ├── launchpad.routes.js
│ ├── tags.routes.js
│ └── ...
├── controllers/
├── models/
├── utils/
│ └── ApiError.js
├── db.js
├── server.js
├── .env.example
└── README.md

What can you contribute in this?

  1. Update all the data in the database with the original authentic data of isro launches
  2. Add more endpoints
  3. Implement pagination, sorting, and filtering for large datasets.
  4. Improve error handling and response structure.
  5. Add authentication (e.g., JWT) for managing admin-level operations.

🛡️ License

This project is licensed under the MIT License.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit PRs.

🙌 Acknowledgements

Inspired by India's space program 🚀 Built with ❤️ using Node, Express, and Railway.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published