-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add instructions for building webpage locally (#80)
- Loading branch information
1 parent
68b2424
commit 0488d9c
Showing
1 changed file
with
20 additions
and
0 deletions.
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,23 @@ | ||
# NorthstarTF | ||
|
||
The NorthstarTF repository holds the code for the [northstar.tf](https://northstar.tf) website. | ||
|
||
## Developing | ||
|
||
To render the webpage locally you will need to have [`yarn`](https://yarnpkg.com/) installed. | ||
|
||
Then run | ||
|
||
```sh | ||
yarn | ||
``` | ||
|
||
once to install the necessary dependencies. | ||
|
||
After that | ||
|
||
```sh | ||
yarn dev | ||
``` | ||
to build the webpage and run a local webserver displaying the changes. | ||
It should live update everytime you perform any changes display them. |