A free and open source PWA for the card game Sheepshead. Or, it will be soon.
Note: this app requires Docker
- Fork this repository and clone it to your machine.
- Checkout the development branch:
git checkout develop - Copy the
.env.templatefile into the same directory, naming the copy.env. - Run
npm installin both theclient/andserver/directories (not in root). - Spin up the Docker containers (this may take a few minutes):
docker compose up - From the
app-servercontainer command line, run:curl --location --request POST 'http://auth-server:3567/recipe/dashboard/user' --header 'rid: dashboard' --header 'api-key: supertokensapikey0123456789' --header 'Content-Type: application/json' --data-raw '{"email": "authuser@so.com", "password": "supertokenspw1"}'- This sets up the auth dashboard with a test admin account.
npx prisma migrate dev --name init- This initializes the app database according to our prisma schema.
-
Access pgAdmin at
http://localhost:6432/browser/- Username:
appuser@so.com - Password:
apppw - Connect to the database:
- Select "add new server"
- In the general tab:
- name:
appdb
- name:
- In the connection tab:
- hostname:
app-db - port:
5432 - maintainence database:
appdb - username:
appuser - password:
apppw
- hostname:
- press "save"
- The relevant information is in
Servers > appdb > Databases (2) > appdb > Schemas (1) > public
- Username:
-
Access the SuperTokens auth dashboard at
http://localhost:4000/auth/dashboard/- Username:
authuser@so.com - Password:
supertokenspw1
- Username:
Users interested in expanding functionalities in Sheepshead Online are welcome to do so. Issues reports are encouraged through Github's issue tracker. See details on how to contribute and report issues in CONTRIBUTING.md. All contributors are expected to adhere to the Code of Conduct.
This software is licensed under the AGPL-3.0 license.
We owe a big thanks to all the projects that make Sheepshead Online run.