Releases: paragrudani1/bharat-api
Releases · paragrudani1/bharat-api
Bharat API v1.0.0 - Initial Release
🎉 Bharat API v1.0.0 - Initial Release
🚀 What's New
This is the initial stable release of Bharat API - a free and open-source Indian pincode and location API.
✨ Features
- 🔍 Pincode Lookup API - Get location details for any Indian pincode
- 🏙️ City & State Search - Find all pincodes for cities and states
- ⚡ High Performance - Built with Express.js and SQLite for fast responses
- 🐳 Docker Ready - Complete containerization for easy deployment
- 📊 Comprehensive Data - 19,000+ locations across all Indian states
- 👨💻 Developer Friendly - Clean REST API with JSON responses
🛠️ Tech Stack
- Backend: Node.js + Express.js + TypeScript
- Database: SQLite with Knex.js ORM
- Development: Hot reload with Nodemon
- Containerization: Docker & Docker Compose
- Data: Complete Indian pincode dataset included
📡 API Endpoints
GET /api/pincode/{pincode}- Lookup by pincodeGET /api/search?city={city}- Search by cityGET /api/search?state={state}- Search by stateGET /health- Health check
🚀 Quick Start
# Using Docker (Recommended)
git clone https://github.com/your-username/bharat-api.git
cd bharat-api
cp .env.example .env
docker-compose up -d
# Local Development
npm install
npm run setup
npm run dev📦 What's Included
- Complete source code with TypeScript
- Docker configuration for development and production
- Database migrations and CSV import scripts
- Comprehensive documentation
- Indian pincode dataset (19,000+ entries)
🤝 Contributing
Contributions are welcome! Please read our contributing guidelines and feel free to submit pull requests.
📄 License
MIT License - free for commercial and personal use.
Made with ❤️ for the Indian developer community
For support, please open an issue on GitHub.