Skip to content

Chore: Update README to make it easier for contributors #43

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,31 @@
# learnbuildteach.com

## Contribution
## Running Locally
To run locally, fork the repository and install the required dependancies:

```bash
npm i
```

Run by using the following command:

```bash
npm run dev
```

### Supabase Credentials
You will need access to the test Supabase instance for local development. For access, please send James (jamesqquick) a message on Discord!
Once you have them, create a `.env` file in the root directory and add the credentials to the file. (See `env.example` for what that would look like)

### Accessing Admin Area
- navigate to `/signup` and create an account
- use your actual email address, use the link in the email from Supabase to confirm your account
- you can now sign in at `/login`

## Contributing
Thank you for wanting to contribute to learnbuildteach.com! You may want to start by looking at some existing issues. If you notice something that needs improvement
please create an issue outlining the probelm and then go ahead and start working on a PR.

To get access to the test Supabase instance, please send James (jamesqquick) a message on Discord!
Linting and formatting are handled via the following commands:
- Lint: `npm run lint`
- Format: `npm run format`