-
Notifications
You must be signed in to change notification settings - Fork 58
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
1 parent
9d17406
commit 6433cd2
Showing
1 changed file
with
18 additions
and
0 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 |
---|---|---|
@@ -1 +1,19 @@ | ||
## Shuttle AI Playground | ||
This template enables you to spin up an AI playground in the style of OpenAI. | ||
|
||
## Features | ||
- Frontend (via Next.js) | ||
- Authentication and sign-ups with cookie-wrapped JWTs | ||
- Database | ||
- OpenAI | ||
|
||
## How to use | ||
Before using this, you will need an OpenAI API key. | ||
|
||
1) Ensure the OpenAI API key is in your `Secrets.toml` file (see file for syntax if not sure how to use). | ||
2) Run `npm --prefix frontend install && npm --prefix frontend run build` to build the Next.js frontend. | ||
3) Use `shuttle run` to run the template locally - or use `shuttle deploy` to deploy! | ||
|
||
## Troubleshooting | ||
- The default port is at 8000. If you are already running something here, you can use `--port` to select a different port. | ||
- Your OpenAI client may error out if you don't have your OpenAI API key set correctly (should be `OPENAI_API_KEY` in Secrets.toml). |