diff --git a/README.md b/README.md index 63f97939..d349b8cd 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file + +This project is licensed under the MIT License. +See [LICENSE](LICENSE) for details. diff --git a/docs/clerk.md b/docs/clerk.md new file mode 100644 index 00000000..0b5e608e --- /dev/null +++ b/docs/clerk.md @@ -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