Skip to content

Commit d1502d4

Browse files
committed
docs: Expand README for OAuth instruction
1 parent 867ec69 commit d1502d4

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ Our collection of carefully selected technologies, guaranteed to be outdated by
6565
1. Clone the repository:
6666

6767
```bash
68-
git clone https://github.com/heigvd-software-engineering/workflow.git
69-
cd workflow
68+
git clone https://github.com/dafthunk-com/dafthunk.git
69+
cd dafthunk
7070
```
7171

7272
2. Install dependencies:
@@ -82,7 +82,30 @@ Our collection of carefully selected technologies, guaranteed to be outdated by
8282
# Edit with custom values
8383
```
8484

85-
4. Create a Cloudflare account and login with Wrangler, a process that's almost as straightforward as it sounds:
85+
```
86+
WEB_HOST=http://localhost:3000
87+
CLOUDFLARE_ENV=development
88+
89+
JWT_SECRET=your_32_character_secret_here
90+
```
91+
92+
4. Configure authentication:
93+
94+
For example, using GitHub OAuth:
95+
- Go to [GitHub Settings > Developer settings > OAuth Apps](https://github.com/settings/applications/new)
96+
- Create new OAuth App with:
97+
- Application Name: `Dafthunk Dev`
98+
- Homepage URL: `http://localhost:3000`
99+
- Authorization callback URL: `http://localhost:3001/auth/login/github`
100+
- Copy the Client ID and generate a new client secret
101+
- Add them to your `.dev.vars` file:
102+
103+
```
104+
GITHUB_CLIENT_ID=your_client_id_here
105+
GITHUB_CLIENT_SECRET=your_client_secret_here
106+
```
107+
108+
5. Create a Cloudflare account and login with Wrangler, a process that's almost as straightforward as it sounds:
86109

87110
```bash
88111
# Install Wrangler globally
@@ -95,13 +118,20 @@ Our collection of carefully selected technologies, guaranteed to be outdated by
95118
wrangler d1 create DB
96119
```
97120

98-
5. Start the development server and cross your fingers:
121+
6. Apply the database migration files
122+
123+
```bash
124+
cd apps/api
125+
pnpm db:migrate
126+
```
127+
128+
7. Start the development server and cross your fingers:
99129

100130
```bash
101131
pnpm dev
102132
```
103133

104-
6. Open your browser and navigate to `http://localhost:3000`. Prepare to either celebrate or debug.
134+
8. Open your browser and navigate to `http://localhost:3000`. Prepare to either celebrate or debug.
105135

106136
## 👨‍💻 Development
107137

0 commit comments

Comments
 (0)