This project is currently in a pre-release stage and is not ready for production use.

We are actively developing this API gateway in public, and the codebase is subject to significant changes. Public contributions are not accepted. If you wish to contribute, please contact me at my email please be aware that the project may not yet be stable or fully functional.

Stay tuned for updates as we continue to work towards a stable release!

Welcome to the API Gateway for accessing Panchang (Hindu calendar) and Hindu festival data. This project is under active development and aims to provide secure and efficient public access to the core Panchang API used by the QuickPanchang macOS app.

Check out the project development plan here to get updates on the project's development.

This project is an API gateway built using Go (Golang) following a microservices architecture. The main components include:

1. User Registration and Authentication: System with email verification to ensure secure access.
2. API Key Management: Enables users to generate and manage API keys for accessing Panchang and festival data.
3. Rate Limiting and Request Tracking: Monitors and controls API usage to prevent abuse.
4. Caching Mechanism: Optimizes data retrieval for better performance.
5. Proxy Functionality: Forwards authenticated requests to the existing core Panchang API.

• Persistent Data Storage: Uses PostgreSQL for storing user information, API keys, and usage analytics.
• Temporary Data Storage: Utilizes Redis for OTPs, session data, and caching.
• Containerization: Dockerized setup for easy deployment and orchestration with Docker Compose.
• Secure and Scalable: Incorporates password hashing, API key generation, and protection against fraudulent signups.

• User Registration: Allows new users to register.
• Email Verification: Confirms user registration via email.
• Data Retrieval: Provides Panchang and Hindu festival information.
• Usage Statistics: Tracks API usage and provides analytics.

To see the core Panchang API in action, check out the QuickPanchang macOS app. This app utilizes the core API to provide comprehensive Panchang and festival data to users.

Guide will be added after release.

Head over to our Matrix Space for discussions, suggestions and chat: QuickPanchang on Matrix

Not currently accepting any contributions from the community. Sorry. This will be enabled after v1 release. Right now this project is being developed in public by internal developers, namely:

• Amartya Yadav
• Ishika Agarwal

This project is licensed under the MIT License.

We might open source the core Panchang API in the future. Stay tuned for updates!

For any questions or suggestions, feel free to reach out at my email or open an issue.

Thank you for checking out our project! We hope you find it useful and look forward to your contributions.

Happy Coding!