Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericyd/oscars-viewing-party
https://github.com/ericyd/oscars-viewing-party
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ericyd/oscars-viewing-party
- Owner: ericyd
- License: unlicense
- Created: 2024-02-08T00:53:35.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-16T20:39:36.000Z (10 months ago)
- Last Synced: 2024-06-01T03:01:35.775Z (7 months ago)
- Language: JavaScript
- Size: 327 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Oscars® Viewing Party
A quick/easy app to store Oscars predictions.
This app is all about "good enough". It is not secure and that's fine. The whole point is just to make predictions for a silly awards ceremony and compare with your friends.
Hosted at https://oscars-pool.pages.dev
## Prerequisites
- [NodeJS](https://nodejs.org/en) ([asdf](https://asdf-vm.com/) recommended)
- [Docker](https://www.docker.com/) (and docker-compose)
- [Atlas](https://atlasgo.io/) (optional)
- [Just](https://github.com/casey/just/blob/master/README.md#packages) (optional)
## Development
With `just`, `atlas`, `docker` and `node`
```shell
just setup migrate worker
# start the Vue frontend in a separate terminal tab
just frontend
```
With only `atlas`, `docker` and `node`
```shell
cp .env.sample .env
cp .dev.vars.example .dev.vars
cp atlas.hcl.sample atlas.hcl
# start DB
docker-compose up -d
# apply DB migration
# If you don't want to use Atlas, just run the SQL files from the migrations directory
atlas migrate apply --env local
# install node dependencies
npm ci
# Start the Cloudflare worker backend
npm run dev
# Start the Vite server for the Vue frontend
npm run client:dev
```
With `docker` and `node`
```shell
cp .env.sample .env
cp .dev.vars.sample .dev.vars
docker-compose up -d
# run migrations manually
for filename in migrations/*.sql; do docker exec db psql -U postgres -d local -f "/$filename"; done
# or if that loop syntax doesn't work:
# docker exec db psql -U postgres -d local -f migrations/20240208014006_full_schema.sql
# docker exec db psql -U postgres -d local -f migrations/20240208024216_insert_categories.sql
# docker exec db psql -U postgres -d local -f migrations/20240211233622_drop_rooms.sql
npm ci
npm run dev
npm run client:dev
```
## Database
Use Atlas to manage the DB.
- Exec into the DB container: `just psql`
- Inspect schema: `just schema-inspect`
- Apply schema changes: `just schema-apply`
- Generate SQL: `just migrate-diff`
- Apply "insert" migrations: `atlas migrate apply --env local --baseline 20240208024216`
- Add new migration file: `atlas migrate new` (after adding SQL, run `atlas migrate hash` to rehash)
- Drop the DB and restart: `just down`
- Dump a remote database: `docker exec -it db pg_dump -d dbname -h host -p port -U user -f migrations/prod.sql`
- this works because `/migrations` is already bound to the container