-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 |