Skip to content

Commit

Permalink
chore: updated readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
birme committed Dec 6, 2024
1 parent 50aba39 commit 5eb680e
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@
White-label AI chat service ready to be embedded on your site
<br />
<br />
:book: <b><a href="https://eyevinn.github.io/{{repo-name}}/">Read the documentation (github pages)</a></b> :eyes:
<br />
</div>

<div align="center">
<br />

[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/eyevinn/{{repo-name}}/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[![made with hearth by Eyevinn](https://img.shields.io/badge/made%20with%20%E2%99%A5%20by-Eyevinn-59cbe8.svg?style=flat-square)](https://github.com/eyevinn)
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/Eyevinn/ai-agent/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[![made with hearth by Eyevinn](https://img.shields.io/badge/made%20with%20%E2%99%A5%20by-Eyevinn-59cbe8.svg?style=flat-square)](https://github.com/Eyevinn)
[![Slack](http://slack.streamingtech.se/badge.svg)](http://slack.streamingtech.se)

</div>
Expand All @@ -31,9 +29,23 @@ Open AI account
% npm install
```

Start service

```
% OPENAI_API_KEY=<api-key> npm start
```

Service is available on http://localhost:8000

The default port 8000 can be overridden with the environment variable `PORT`

```
% PORT=8080 OPENAI_API_KEY=<api-key> npm start
```

## Development

Start API service
Start backend as usual

```
% OPENAI_API_KEY=<api-key> npm start
Expand Down

0 comments on commit 5eb680e

Please sign in to comment.