Welcome to the Keizai API documentation. This project is organized into several modules, each responsible for different functionalities within the application. Below you will find links to the detailed documentation for each module.
The Keizai API is a service similar to Postman but designed specifically for managing and interacting with Soroban smart contracts.
- User Module
- Team Module
- Role Module
- Method Module
- Invocation Module
- Invitation Module
- Folder Module
- Collection Module
- Blockchain Network Status Module
- Environment Module
- Ephemeral Environment Module
- Authorization Module
- Authentication Module
- Stellar Service Module
- S3 File Upload Service
- Response Service
- Cognito Service
- Common Base Module
The Keizai API is designed to manage various aspects of the application, including users, teams, roles, methods, invocations, invitations, folders, collections, and blockchain network status. Each module is documented in detail to help you understand its components and how to use them.
- Docker
- Docker Compose
- Node.js (version 16 or higher)
- npm (version 7 or higher)
To get started with the Keizai API, please follow the steps below:
git clone https://github.com/keizai-tools/keizai-api.git
cd keizai-apinpm installCopy the .env.dist file to .env and update the values as needed.
cp .env.dist .envMake sure Docker and Docker Compose are installed and running on your machine. Then, start the Docker containers:
docker-compose up -dnpm run start:devThe application should now be running at http://localhost:3002/api.
We welcome contributions to the Keizai API. If you would like to contribute, please read our contributing guidelines and code of conduct.
This project is licensed under the MIT License - see the LICENSE file for details.