IMPHNEN Backend Service
This repository serves as the monorepo for all backend services of IMPHNEN. It encompasses several main services:
- Core Service - Provides fundamental functionalities and shared resources for other services.
- IAM Service - Handles identity and access management across IMPHNEN applications.
- CMS Service - Supports the cms services by IMPHNEN Landing Page website.
- Gacha Service - Supports the gacha services by IMPHNEN Gacha website.
- Dimentorin Service - Supports the mentoring services by IMPHNEN Dimentorin website.
- Gateway Service - Acts as the API gateway, routing requests to appropriate services.
How to Install
-
Clone the repository:
git clone https://github.com/IMPHNEN/imphnen-backend-service.git cd imphnen-backend-service -
Set up the environment:
-
Copy the example environment files:
cp .env.example .envif you use windows based system
./apply-env.ps1if you use unix based system
sh apply-env.sh -
Modify the
.envfiles with your specific configuration settings.
-
-
Install dependencies:
Ensure you have Rust installed. Then, run:
cargo build
How to Run
Development
To run the services in development mode:
-
Start the database and other dependencies using Docker Compose:
docker-compose up -d -
Run the desired service. For example, to run the Core Service:
cargo run -p imphnen-core-service --bin api
Production
For production deployment:
-
Build the Docker image:
docker build -t imphnen-backend-service . -
Run the Docker container:
docker run -d --env-file .env -p 8080:8080 imphnen-backend-serviceAdjust the port and environment variables as needed.
How to Contribute
-
Fork the repository and clone it locally.
-
Create a new branch for your feature or fix:
git checkout -b feat/your-feature-name -
Make your changes, commit them, and push to your forked repository.
-
Create a pull request to the
developbranch of this repository.
If you encounter any issues or have questions, feel free to create a new issue in the repository.
Note: For detailed API documentation, please refer to our API Docs.