Table of Contents
- ISRO Launches Dashboard (Using the ISRO API)
- Installation
- Usage
- API
- Contributing
- License
- Author
ISRO Launches π Dashboard (Using the ISRO API)
This project lets you search for ISRO Launches and displays information about them.
Installation
- Clone this repository using
git clone https://github.com/iamvisshu/ISRO_Launches_API.git
. - Open the project directory in your code editor.
- You'll don't need to obtain any ISRO API access token as it's public api.
- Follow the instructions on https://services.isrostats.in/api/launches/.
Usage
- Make sure you have your ISRO access token stored securely (if needed, in my case it was not).
- Open
index.html
(or the main HTML file) in your web browser. - Enter a launch name or vehicle in the search bar and press Enter.
- The project should fetch information about the searched launch(s) from the ISRO API and display it on the page.
API
This project uses the ISRO Web API https://services.isrostats.in/api/launches/.
Please refer this documentation https://isrostats.in/apis to know more about it.
Contributing
We welcome contributions to this project! If you'd like to contribute, please:
- Fork the repository on GitHub.
- Make your changes and create a pull request.
- Follow any coding style guidelines mentioned in the code (if any).
License
This project is licensed under the Open-source [MIT License].
Author
@iamvisshu - Vishal Vishwakarma
Additional Sections (Optional)
- Features: - Briefly list the functionalities of your project (e.g., search by launches name, Launch date, Vehicle, Payloads).
- Screenshots or Demos: - Include screenshots or a link to a live demo if applicable.
- Troubleshooting: - Offer solutions to common problems users might encounter (e.g., invalid access, API rate limits).
- Credits: - Acknowledge the ISRO API and any other third-party libraries or code used in your project.
Important Note:
- Security: Avoid mentioning how to store the access token directly in the README. Emphasize secure storage mechanisms.
- API Usage: Be mindful of ISRO's API terms of use and rate limits. You might want to add a note about responsible API usage.