Skip to content

Commit

Permalink
docs: add clerk doc and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jsun969 committed Feb 17, 2024
1 parent 3f800ab commit c88199b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,35 @@ This is the official repository for the University of Adelaide Computer Science

## Getting Started

To get started, please follow these steps:
To get started, please follow these steps:

1. Install the dependencies.

```bash
pnpm install
```

2. Set up the required keys:
- Copy `.env.local.example` to a new file `.env.local`.
- Create a [Clerk](https://clerk.com) account and make a new application within the Clerk dashboard.
- Configure the settings to require a name, reject compromised passwords, and enforce average strength passwords.
- Copy the keys to `.env.local`.
2. Copy `.env.local.example` to a new file `.env.local` and set required environment variables (check `/docs` folder if you don't know how to edit it)

3. Initialise the database.

```bash
pnpm run db:push
```

4. Then run the development server.
4. Run the development server.

```bash
pnpm run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
5. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Contributing

We welcome contributions to enhance the CS Club Website! If you find any issues, have suggestions, or want to request a feature, please follow our [Contributing Guidelines](CONTRIBUTING.md).

## License
This project is licensed under the MIT License.
See [LICENSE](LICENSE) for details.

This project is licensed under the MIT License.
See [LICENSE](LICENSE) for details.
11 changes: 11 additions & 0 deletions docs/clerk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Clerk

## Getting started

1. Create a [Clerk](https://clerk.com) account and make a new application within the Clerk dashboard.
2. Configure the settings to require a name, reject compromised passwords, and enforce average strength passwords.

## Admin account

1. Go to user profile in clerk dashboard
2. Set `{ "isAdmin": true }` in public metadata

0 comments on commit c88199b

Please sign in to comment.