Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
ref #229
  • Loading branch information
ygrishajev committed Jun 18, 2024
1 parent 4077742 commit 041ba48
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,28 @@

</div>

- [Quick Start](#quick-start)
- [Services](#services)
- [Monitoring](#monitoring)
- [Example SQL Queries](#example-sql-queries)
- [Running the Application](#running-the-application)
- [How to run](#how-to-run)
- [Database Structure](#database-structure)

# Quick start

We use `docker` with `docker compose` to run the services. This is the easiest way to get started. For instance to run the deploy-web service:

```bash
git clone [email protected]:akash-network/cloudmos.git ./console
cd console
npm run dc:up:dev -- deploy-web
```

This would start the deploy-web service in development mode with all the dependencies (api, indexer, postgres) needed. While spinning up postgres it would also import a backup of the sandbox (by default) database to speed up the process.

For more details on how to run the other services or modes see the [Running the Application](#running-the-application) section.

# Services

## Dataflow between services
Expand Down

0 comments on commit 041ba48

Please sign in to comment.