71 lines
1.4 KiB
Markdown
71 lines
1.4 KiB
Markdown
|
# Scripts
|
||
|
|
|
||
|
|
Development and deployment scripts for the ChainID 138 Explorer Platform.
|
||
|
|
|
||
|
|
## Available Scripts
|
||
|
|
|
||
|
|
### `setup.sh`
|
||
|
|
Initial setup script that:
|
||
|
|
- Creates `.env` file from `.env.example`
|
||
|
|
- Installs backend dependencies (Go modules)
|
||
|
|
- Installs frontend dependencies (npm)
|
||
|
|
- Starts infrastructure services (PostgreSQL, Elasticsearch, Redis)
|
||
|
|
- Runs database migrations
|
||
|
|
|
||
|
|
**Usage:**
|
||
|
|
```bash
|
||
|
|
./scripts/setup.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
### `check-requirements.sh`
|
||
|
|
Checks if all required tools are installed:
|
||
|
|
- Go 1.21+
|
||
|
|
- Node.js 20+
|
||
|
|
- Docker
|
||
|
|
- Docker Compose
|
||
|
|
|
||
|
|
**Usage:**
|
||
|
|
```bash
|
||
|
|
./scripts/check-requirements.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
### `run-dev.sh`
|
||
|
|
Starts all services in development mode:
|
||
|
|
- Infrastructure services (PostgreSQL, Elasticsearch, Redis)
|
||
|
|
- Database migrations
|
||
|
|
- Indexer service
|
||
|
|
- API server
|
||
|
|
- Frontend development server
|
||
|
|
|
||
|
|
**Usage:**
|
||
|
|
```bash
|
||
|
|
./scripts/run-dev.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
**Note:** Press Ctrl+C to stop all services.
|
||
|
|
|
||
|
|
### `deploy.sh`
|
||
|
|
Production deployment script (to be configured).
|
||
|
|
|
||
|
|
### `test.sh`
|
||
|
|
Run tests (to be configured).
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
### Script not found
|
||
|
|
Make sure you're running scripts from the project root directory:
|
||
|
|
```bash
|
||
|
|
cd explorer-monorepo
|
||
|
|
./scripts/run-dev.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
### Permission denied
|
||
|
|
Make scripts executable:
|
||
|
|
```bash
|
||
|
|
chmod +x scripts/*.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
### Script fails with path errors
|
||
|
|
The scripts automatically detect the project root, but if you encounter issues, make sure you're in the `explorer-monorepo` directory when running them.
|
||
|
|
|