Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vganshin committed Apr 11, 2023
1 parent e4c7b6f commit 1424798
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,22 @@

This repository contains Aidbox base project. You can use to bootsrap your project with Aidbox.

# installation
# Install & run

To begin with new aidbox project, run the following command.
In order to run Aidbox locally, you need to have [Docker & Docker compose installed](https://docs.docker.com/engine/install/). To begin with new aidbox project, run the following command.

```sh
git clone --depth=1 --branch=main [email protected]:Aidbox/aidbox-project-template.git aidbox-project && cd aidbox-project && rm -rf .git
```

Get your Aidbox license on [aidbox.app](https://aidbox.app/). And then put it to [.env file](.env#L1).
Get your Aidbox license on [aidbox.app](https://aidbox.app/). And then set `AIDBOX_LICENSE` env variable in [.env file](.env#L1).

Once you set the license key, you may run Aidbox service with Docker compose by running:

``` sh
docker compose up
```

# What's next

You may learn more on Aidbox project in Aidbox documentation. For production read another doc

0 comments on commit 1424798

Please sign in to comment.