https://github.com/alexis-moins/dash
Manage and review your collection of decks of flashcards locally 🚀
https://github.com/alexis-moins/dash
bun elysiajs htmx prisma tailwindcss typescript
Last synced: 2 months ago
JSON representation
Manage and review your collection of decks of flashcards locally 🚀
- Host: GitHub
- URL: https://github.com/alexis-moins/dash
- Owner: alexis-moins
- Created: 2023-09-18T14:17:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-08T17:52:28.000Z (over 2 years ago)
- Last Synced: 2025-01-10T01:15:14.288Z (over 1 year ago)
- Topics: bun, elysiajs, htmx, prisma, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```
_ _
| | | |
__| | __ _ ___| |__
/ _` |/ _` / __| '_ \
| (_| | (_| \__ \ | | |
\__,_|\__,_|___/_| |_|
```
---
`dash` is a platform desigend to help you manage and review your collection of decks of flashcards locally 🚀. It uses `bun`, `ElysiaJS` + `jsx`, `prisma`, `tailwind CSS` and `HTMX` under the hood to provide a minimalist yet reactive exprerience.
## Prerequisites
- [bun](https://bun.sh)
- [just](https://github.com/casey/just)
- [docker](https://www.docker.com) (and docker-compose!)
## 🧰 Setup
Clone the repository anywhere on your machine
```bash
git clone git@github.com:alexis-moins/dash.git
```
Install the dependencies using bun
```bash
bun install
```
Create a .env file from the [.env.local](./.env.local) file
```bash
cp .env.local .env
```
Launch the database container
```bash
just up
```
## 🌱 Seeding the database
> First, ensure the database container is running! You should see it when typing `docker ps`
Create the tables used by dash
```bash
bunx prisma db push
```
Seed the database with default data
```bash
bunx prisma db seed
```
## 🚦 Starting your journey
> Until prisma works in a bun docker container, we need to manually start the project aside from launching the database container.
Start the server
```bash
bun run dev
```
Visit dash [here](http://localhost:3030)!