Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(contribution-guidelines): update installation steps #169

Merged
merged 7 commits into from
Nov 1, 2024
Merged

docs(contribution-guidelines): update installation steps #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0db64f6
docs(contribution-guidelines/quick-start): add note on docker daemon
JowiAoun Nov 1, 2024
8793d46
docs(contribution-guidelines/quick-start): remove legacy steps
JowiAoun Nov 1, 2024
dea1eac
docs(contribution-guidelines/quick-start): modify google auth descrip…
JowiAoun Nov 1, 2024
7cddde3
docs(contribution-guidelines/quick-start): change drizzle migrate com…
JowiAoun Nov 1, 2024
86c02a6
docs(contribution-guidelines/quick-start): fix typo app name web to w…
JowiAoun Nov 1, 2024
7e6d65e
chore(libs/env): make DATABASE_URL optional
JowiAoun Nov 1, 2024
15ebd06
chore(libs/db): use development DATABASE_URL when not provided
JowiAoun Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 16 additions & 52 deletions apps/docs/src/content/docs/contribution-guidelines/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,56 +177,21 @@ pnpm i
<div className="step">
Spin up development docker containers, one of which contains the PostgreSQL database.

<Callout type="warn" title="Hold your horses!">
Docker daemon (i.e. Docker Desktop) should be running before proceeding!
</Callout>

```sh title="terminal"
docker-compose up -d
```
</div>

<Accordions>
<Accordion title="Legacy steps (will be removed soon)">
This is what the steps looked like from this point onwards prior to the monorepo migration.

<div className="steps">
<div className="step">
Run PostgreSQL in Docker

<Callout type="warn">
If you have a local PostgreSQL server running, you may need to stop it before running the Docker container.
</Callout>

```sh title="Terminal"
docker-compose up -d db
```

<Callout >
You can also build and run the app itself with [Docker Compose](https://docs.docker.com/compose/).

```sh title="Terminal"
docker-compose up -d --build
```

</Callout>
</div>

<div className="step">
Run Prisma Migrate
Enable authentication providers. OAuth providers need to be configured for you to use authentication in your development environment.

```sh title="Terminal"
pnpm prisma migrate dev
```

</div>

<div className="step">
Run development server

```sh title="Terminal"
pnpm dev
```

</div>

### Enable Google OAuth
<Accordions>
<Accordion title="Google OAuth">

<div className="steps">
<div className="step">
Expand All @@ -243,24 +208,24 @@ pnpm dev
redirect URI.
</div>
<div className="step">
Copy the client ID and client secret into your `.env` file as
`GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`.
Make a copy of the `.env.example` file in the `apps/portal` directory, and rename it to `.env.local`.
Then, copy & paste the google client ID and secret into your the `.env.local` file as
`GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` respectively.
</div>
<div className="step">Restart the development server.</div>
</div>

You should now be able to sign in with Google.

</div>

</Accordion>
</Accordions>
</div>

<div className="step">
Run Drizzle Migrate
Run Drizzle Push, to push the latest migration to your development database.

```sh title="Terminal"
pnpm nx run db:migrate
pnpm nx run db:push
```

</div>
Expand All @@ -273,18 +238,17 @@ You should now be able to sign in with Google.
<Tabs groupId="website-project-nx-commands" items={['dev', 'build', 'start']} persist>
<Tab value="dev">
```sh title="Terminal"
pnpm nx run web:dev
pnpm nx run website:dev
```
</Tab>
<Tab value="build">
```sh title="Terminal"
pnpm nx run web:build
pnpm nx run website:build
```
</Tab>
<Tab value="start">
```sh title="Terminal"
```sh title="Terminal"
pnpm nx run web:start
pnpm nx run website:start
```
</Tab>
</Tabs>
Expand Down
2 changes: 1 addition & 1 deletion libs/db/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import postgres from 'postgres'
import { envWebsiteDb } from '@cuhacking/env'
import * as schema from './schema'

const sql = postgres(envWebsiteDb.DATABASE_URL)
const sql = postgres(envWebsiteDb.DATABASE_URL || 'postgresql://postgres:password@localhost:5432/hackathon')

export const db = drizzle(sql, {
schema,
Expand Down
2 changes: 1 addition & 1 deletion libs/env/src/website/db.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { sharedEnv } from '../shared'
export const envWebsiteDb = createEnv({
extends: [sharedEnv],
server: {
DATABASE_URL: z.string().url().startsWith('postgres'),
DATABASE_URL: z.string().url().startsWith('postgres').optional(),
},
experimental__runtimeEnv: {
DATABASE_URL: process.env.DATABASE_URL,
Expand Down
Loading