Skip to content

Commit cce9a1b

Browse files
committed
chore: add new envs and update readme
1 parent aa9a24c commit cce9a1b

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

.env.example

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1-
SUPABASE_URL="https://example.supabase.co"
2-
SUPABASE_KEY="<your_key>"
3-
SUPABASE_SERVICE_KEY="<your_service_key>"
1+
# Your Supabase Instance URL, required
2+
SUPABASE_URL="https://exampke.supabase.co"
3+
# Supabase Anonymous Key, required
4+
SUPABASE_KEY="my cool key"
5+
# Supabase Service Role Key, required
6+
SUPABASE_SERVICE_KEY="my cool key"
7+
# Cloudflare Turnstile Secret Key, used for registration
8+
NUXT_TURNSTILE_SECRET_KEY="0x bunch of letters"
9+
# Lichess "Code Challenge" and "Code Verifier" keys, used for Lichess OAuth, optional
10+
LICHESS_CODE_CHALLENGE="fancy encrypted string"
11+
LICHESS_CODE_VERIFIER="boring unencrypted string"
12+
# The Base URL of the your API, usually your site URL, required
13+
API_BASE_URL="http://localhost:3000"

README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Chess.Tools Site
22

3-
View all your chess stats across federations and chess websites on one site!
3+
The ultimate Chess website for statiaticians. View all your chess stats across federations and chess websites on one site!
44

55
## Features
66

77
(All in progress, but planned!)
88

9-
- [x] View your USCF stats
10-
- [x] View your Lichess stats
9+
- [x] Notate your OTB games with the game viewer
1110
- [x] View your Chess.com stats
12-
- [x] View your Chess24 stats
11+
- [x] View your Lichess stats
12+
- [x] View your US Chess stats
1313
- [x] View your FIDE stats
1414

15-
More!
15+
And even more features coming soon!
1616

1717
## Development
1818

@@ -27,7 +27,7 @@ This site uses Nuxt, a Vue framework. We use Bun as our package manager.
2727

2828
### Setting Up Development Environment
2929

30-
1. Clone the repo
30+
1. Fork and clone the repo
3131
2. Run `bun install` to install dependencies
3232
3. Prepare the `.env` file as follows
3333
```
@@ -39,6 +39,7 @@ This site uses Nuxt, a Vue framework. We use Bun as our package manager.
3939
SUPABASE_KEY="<your_key>"
4040
SUPABASE_SERVICE_KEY="<your_service_key>"
4141
```
42-
5. Run `bun run dev` to start the development server
43-
6. Go to `localhost:3000` to view the site
44-
7. Make changes and submit a pull request!
42+
5. Fill out extra `.env` options as needed
43+
6. Run `bun run dev` to start the development server
44+
7. Go to `localhost:3000` to view the site
45+
8. Make changes and submit a pull request!

0 commit comments

Comments
 (0)