Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobCoffee committed Nov 5, 2023
1 parent 23beff6 commit d900885
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
> - Upload Threads/Forum Posts to GitHub discussions
> - Sync commit contributions for a repo or organization to a Discord role (Commit Club type gamification)
> - Create GitHub issue from thread, forum post, or comment
>
> and whatever else is found to be useful.
All of this may go down in flames, though... so... yeah - good luck 😅
Expand All @@ -21,9 +22,23 @@ The Discord bot is built on the [Discord.py v2][discordpy] library.
## Web

The web service is a [Litestar][litestar] application. It is utilizing Jinja2[jinja] templating, TailwindCSS[tailwind],
[DaisyUI[daisy], and [Feather icons][feather] for the front end, and the backend is using the Litestar-provided
[DaisyUI][daisy], and [Feather icons][feather] for the front end, and the backend is using the Litestar-provided
utilities for routing, middleware, and more.

## Deployment

Byte is currently deployed to [Railway][railway] for both the bot and the web service in production
and testing.

## Development

You can use the provided [nixpack][nixpacks] config [file](./nixpacks.toml) config,
or set up your environment using PDM[pdm].

## Contributing

All contributions are welcome! Please see [CONTRIBUTING](./CONTRIBUTING.rst) for more information.

### UI Examples

![Home](docs/images/home.png)
Expand All @@ -37,3 +52,6 @@ utilities for routing, middleware, and more.
[tailwind]: https://tailwindcss.com/
[daisy]: https://daisyui.com/
[feather]: https://feathericons.com/
[railway]: https://railway.app?referralCode=BMcs0x
[nixpacks]: https://nixpacks.com/docs/getting-started
[pdm]: https://pdm.fming.dev/latest/

0 comments on commit d900885

Please sign in to comment.