-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,24 @@ | ||
# Hive | ||
|
||
hex implementation taken from react-hexgrid | ||
A recreation of the board game Hive! | ||
|
||
Done as part of CSESoc's Trainee Program. | ||
|
||
## Getting started | ||
|
||
To run the project locally: | ||
|
||
```sh | ||
git clone https://github.com/csesoc/trainee-7-23t3.git | ||
cd trainee-7-23t3 | ||
yarn install | ||
yarn dev | ||
``` | ||
|
||
To install yarn, follow [this guide](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable). | ||
|
||
We use [nvm](https://github.com/nvm-sh/nvm) for node versioning. | ||
|
||
## Live Demo | ||
|
||
You can check out the live demo of the website at https://trainee-7-23t3.fly.dev |