Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixpereira committed Jan 24, 2024
1 parent 0bedbcb commit 5da06f4
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,27 @@ This is the official repository for the University of Adelaide Computer Science

## Getting Started

To get started, first clone the repository and open the folder.
To get started, please follow these steps:
1. Clone the repository and open the folder.

```bash
git clone https://github.com/compsci-adl/website
cd website
```

Next install the dependencies.
2. Install the dependencies.
```bash
pnpm i
```

Set up the keys by copying `.env.local.example` to a new file `.env.local` and replace the placeholder keys with the actual keys. Please contact the open source officers on the CS Club Discord to get these keys.
3. Set up the keys by copying `.env.local.example` to a new file `.env.local` and replace the placeholder keys with the actual keys. Please contact the open source officers on the CS Club Discord to get these keys.

Initialise the database
4. Initialise the database
```bash
pnpm run db:push
pnpm db:push
```

Then run the development server
5. Then run the development server

```bash
pnpm dev
Expand All @@ -35,10 +36,4 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the

## 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 these guidelines:

- Check the [Code Style Guide](docs/coding-style.md) to maintain consistency.
- Open an issue to report problems or discuss potential changes.
- Submit a pull request to propose fixes or improvements.

For more details, check our [Contributing Guidelines](CONTRIBUTING.md).
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).

0 comments on commit 5da06f4

Please sign in to comment.