github.com/alien-Worlds/alienworlds-api ↗
Alien Worlds API
Open this visualization on its own page →
Contributors
6
Lines of Code
339
From
2021-01-28
To
2022-01-20
About alien-Worlds/alienworlds-api
The Alien Worlds API is a TypeScript-based service for indexing and reading blockchain data from the Alien Worlds project. It provides a RESTful API interface built with Fastify for querying and retrieving indexed information about the Alien Worlds ecosystem.
The project uses Docker containerization to manage multiple services, with MongoDB for data storage and a fully dockerized development environment. Developers can work locally with automatic recompilation and hot-reload when editing source files. The setup includes comprehensive tooling for code quality, with ESLint and Prettier for linting and formatting, Husky for Git hooks, and yarn for dependency management.
The API is designed for team development with detailed setup documentation and a CI/CD pipeline that handles building, testing, and pushing Docker images to GitHub's Container Registry. API documentation is generated using Fastify-OAS and published online, making it accessible for developers integrating with the service in both local and production environments.