https://github.com/lightinn/breval-api
https://github.com/lightinn/breval-api
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lightinn/breval-api
- Owner: LightInn
- Created: 2023-08-17T18:12:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-09T22:42:02.000Z (8 months ago)
- Last Synced: 2025-10-10T03:59:38.412Z (8 months ago)
- Language: JavaScript
- Size: 2.78 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Getting started with Strapi
## 📦 Requirements
- [Node.js](https://nodejs.org/en/download/)
- [Yarn](https://yarnpkg.com/getting-started/install)
- [Docker](https://docs.docker.com/get-docker/)
- [Minio](https://docs.min.io/docs/minio-docker-quickstart-guide.html)
- [Caprover](https://caprover.com/docs/get-started.html)
- [Docker Hub](https://hub.docker.com/)
- [Postgres Docker](https://hub.docker.com/_/postgres)
## 🧰 Development
Start your Strapi application with autoReload
enabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-develop)
```
yarn develop
```
## ⚙️ Deployment
### CI / CD environments variables
| Variable | Description |
| ----------------- | ------------------- |
| `APP_URL` | Caprover app url |
| `APP_NAME` | Caprover app name |
| `APP_TOKEN` | Caprover app token |
| `DOCKER_USERNAME` | Docker hub username |
| `DOCKER_PASSWORD` | Docker hub password |
| `APP_IMAGE` | Docker image name |
| `S3_ENDPOINT` | Minio endpoint |
| `S3_PORT` | Minio port |
| `S3_SSL` | Minio ssl enable |
### Docker environments variables
| Variable | Description |
| ------------------- | --------------------------------------------- |
| `HOST` | Straip host listener |
| `PORT` | Straip port listener |
| `APP_KEY` | Set the application key |
| `API_TOKEN_SALT` | Set the API token salt |
| `ADMIN_JWT_SECRET` | Set the admin JWT secret |
| `DB_CLIENT` | Set the database client ( postgres / sqlite ) |
| `DATABASE_HOST` | Set the database host |
| `DATABASE_PORT` | Set the database port |
| `DATABASE_NAME` | Set the database name |
| `DATABASE_USERNAME` | Set the database username |
| `DATABASE_PASSWORD` | Set the database password |
| `S3_ENDPOINT` | Minio endpoint |
| `S3_PORT` | Minio port |
| `S3_SSL` | Minio ssl enable |
| `S3_BUCKET` | Minio bucket name |
| `S3_ACCESS_KEY_ID` | Minio access key id |
| `S3_ACCESS_SECRET` | Minio access secret |