add doc (#32)

Author: rphlmr

apps/drizzle-run/.env.example

@@ -1,11 +1,11 @@
 APP_NAME=Drizzle Run
 APP_URL=http://localhost:3000
-DATABASE_URL=postgres://postgres.{YOUR_INSTANCE_NAME}:{POSTGRES_PASSWORD}@aws-0-eu-central-1.pooler.supabase.com:6543/postgres
-DATABASE_URL_MIGRATE=postgres://postgres.{YOUR_INSTANCE_NAME}:{POSTGRES_PASSWORD}@aws-0-eu-central-1.pooler.supabase.com:5432/postgres
-PLATFORM=development|staging|production
+DATABASE_URL=postgresql://postgres:postgres@localhost:54322/postgres
+DATABASE_URL_MIGRATE=postgresql://postgres:postgres@localhost:54322/postgres
 SENTRY_DSN=
 SESSION_SECRET=super-duper-s3cret
-SUPABASE_ANON_KEY={ANON_PUBLIC}
-SUPABASE_SERVICE_ROLE_KEY={SERVICE_ROLE}
-SUPABASE_URL=https://{YOUR_INSTANCE_NAME}.supabase.co
-TZ=UTC
+SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0
+SUPABASE_SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU
+SUPABASE_URL=http://127.0.0.1:54321
+TZ=UTC
+NODE_ENV=development

apps/drizzle-run/README.md

@@ -5,35 +5,32 @@
 > [!NOTE]
 > Documentation is WIP
 
-## Development
-
-Run the Vite dev server:
-
-```shellscript
-npm run dev
-```
-
-## Deployment
-
-First, build your app for production:
-
-```sh
-npm run build
-```
-
-Then run the app in production mode:
-
-```sh
-npm start
-```
-
-Now you'll need to pick a host to deploy it to.
-
-### DIY
-
-If you're familiar with deploying Node applications, the built-in Remix app server is production-ready.
-
-Make sure to deploy the output of `npm run build`
-
-- `build/server`
-- `build/client`
+## How to run it locally
+
+> [!IMPORTANT]
+> [Install Supabase CLI to self host Supabase](https://supabase.com/docs/guides/local-development/cli/getting-started)
+
+___
+
+> [!IMPORTANT]
+> To use GitHub auth, you need to create an OAuth app on GitHub and add the client ID and secret to the `.env` file at the **root** of the project.
+> 
+> [Follow the docs](https://supabase.com/docs/guides/auth/social-login/auth-github)
+> 
+> ```env
+> SUPABASE_AUTH_GITHUB_CLIENT_ID=
+> SUPABASE_AUTH_GITHUB_SECRET=
+> ```
+> Once done, you can restart the Supabase project with `supabase stop` and `supabase start`.
+
+___
+
+1. Start Supabase locally with `supabase start` and wait until it's done.
+2. Create a `.env` file with the required variables by running `cp .env.example .env`. It already contains all the required environment variables and their values.
+   * NB: `DATABASE_URL_MIGRATE`, on production, it should point to the port `5432` of your db instance.
+3. `npm install`
+4. `cd apps/drizzle-run`
+5. Apply Drizzle migrations `npm run db:server:migration:deploy`
+6. Run `npm run dev` to start the development server
+
+It's a npm workspace monorepo, everything is linked together so if you make changes to `packages/*`, they will be reflected in the app.