Skip to content

Commit

Permalink
Update README.md (#55)
Browse files Browse the repository at this point in the history
Signed-off-by: Bohan Cheng <[email protected]>
  • Loading branch information
cbh778899 authored Aug 16, 2024
1 parent 5a67ed8 commit afe69fc
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# VOYAGER
This project is OpenAI-like API set for SkywardAI project.
The project is OpenAI-like API service of SkywardAI ecosystem.

[![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)
[![Release Drafter 🚀](https://github.com/SkywardAI/voyager/actions/workflows/release-drafter.yml/badge.svg)](https://github.com/SkywardAI/voyager/actions/workflows/release-drafter.yml)
Expand Down Expand Up @@ -50,6 +50,18 @@ make dev
```
**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.

### Setup in your server
1. Download this repo into your host machine.
2. Open [generate_production_env.html](./generate_production_env.html) in your browser and
* Set fields you want to make change according to instructions
* Click `Generate Env File` button on the bottom
* Rename the downloaded file to `.env.production` and copy-paste it into root folder of this project
3. Make sure you installed `docker` and `make` in your host machine.
4. Run command `make up` to build & run, find this app on your host machine's port `8000`.


**Hint**: Check [docker-compose.yaml](./docker-compose.yaml), [Makefile](./Makefile) and [plugin.js](./tools/plugin.js) to make it fits your own preference.

## Lint
To start lint your code, simply run
```shell
Expand Down

0 comments on commit afe69fc

Please sign in to comment.