Skip to content

Commit

Permalink
chore: remove devcontainer configuration and update README for enviro…
Browse files Browse the repository at this point in the history
…nment variables
  • Loading branch information
ker0olos committed Feb 3, 2025
1 parent 17dec89 commit 09590c2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 45 deletions.
39 changes: 0 additions & 39 deletions .devcontainer/devcontainer.json

This file was deleted.

17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,38 @@ A portal app to create, manage and publish community packs

### Contribute

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/fable-community/packs)
<a href="https://fresh.deno.dev">
<img width="175" height="33" src="https://fresh.deno.dev/fresh-badge-dark.svg" alt="Made with Fresh" />
</a>

```
deno task start
```

###### Required Environment Variables:
#### Required Environment Variables

- DISCORD_CLIENT_ID: a discord oauth client id
- DISCORD_CLIENT_SECRET: a discord oauth client secret

###### Optional Environment Variables:
#### Optional Variables

###### Use a self-hosted instance of Fable

- API_ENDPOINT: an endpoint for a self-hosted instance of
[Fable](https://github.com/ker0olos/fable)

###### Send public packs update messages to a discord channel

- PUBLIC_DISCORD_WEBHOOK_URL: a discord webhook url

###### Allow users to upload their own images

- S3_KEY_ID: A S3-compatible key id
- S3_ACCESS_KEY: A S3-compatible key access key
- S3_BUCKET_NAME: A S3-compatible bucket name
- S3_ENDPOINT: A S3-compatible endpoint (for uploading)
- S3_PUBLIC_ENDPOINT: the public url for the bucket (the image file name will be
added to the end e.g.: `S3_PUBLIC_ENDPOINT/filename.png`)

- GEMINI_API_KEY: A [Gemini API Key](https://aistudio.google.com/app/apikey)
###### Allow users to auto generate descriptions

[b2]: https://www.backblaze.com/b2/cloud-storage.html
- GEMINI_API_KEY: A [Gemini API Key](https://aistudio.google.com/app/apikey)

0 comments on commit 09590c2

Please sign in to comment.