Skip to content

Commit afe69fc

Browse files
authored
Update README.md (#55)
Signed-off-by: Bohan Cheng <[email protected]>
1 parent 5a67ed8 commit afe69fc

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# VOYAGER
2-
This project is OpenAI-like API set for SkywardAI project.
2+
The project is OpenAI-like API service of SkywardAI ecosystem.
33

44
[![Linter and Builder 🚀](https://github.com/SkywardAI/voyager/actions/workflows/linter-builder-checker.yml/badge.svg)](https://github.com/SkywardAI/voyager/actions/workflows/linter-builder-checker.yml)
55
[![Release Drafter 🚀](https://github.com/SkywardAI/voyager/actions/workflows/release-drafter.yml/badge.svg)](https://github.com/SkywardAI/voyager/actions/workflows/release-drafter.yml)
@@ -50,6 +50,18 @@ make dev
5050
```
5151
**NOTE:** `make dev` Requires Node.js environment installed, or at least have `node_modules` specified in `package.json` installed on your server. Please see [Local Machine](#local-machine) section.
5252

53+
### Setup in your server
54+
1. Download this repo into your host machine.
55+
2. Open [generate_production_env.html](./generate_production_env.html) in your browser and
56+
* Set fields you want to make change according to instructions
57+
* Click `Generate Env File` button on the bottom
58+
* Rename the downloaded file to `.env.production` and copy-paste it into root folder of this project
59+
3. Make sure you installed `docker` and `make` in your host machine.
60+
4. Run command `make up` to build & run, find this app on your host machine's port `8000`.
61+
62+
63+
**Hint**: Check [docker-compose.yaml](./docker-compose.yaml), [Makefile](./Makefile) and [plugin.js](./tools/plugin.js) to make it fits your own preference.
64+
5365
## Lint
5466
To start lint your code, simply run
5567
```shell

0 commit comments

Comments
 (0)