-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with local build instructions
- Loading branch information
Showing
1 changed file
with
24 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,2 +1,26 @@ | ||
# hpsf.io | ||
HPSF website | ||
|
||
## Requirements | ||
|
||
- [Install Hugo](https://gohugo.io/installation/) version v0.111.3 | ||
- Need to be connected to internet to load [Hinode theme](https://github.com/gethinode/hinode) dependencies and modules | ||
- Clone [this repository](https://github.com/hpsfoundation/hpsf.io) | ||
|
||
<br /> | ||
|
||
## How to run locally | ||
1. Install all requirements | ||
2. Change directory: `<your-path-to-the-repository>` | ||
3. Install dependencies | ||
``` | ||
npm install | ||
``` | ||
4. Start development server | ||
```bash | ||
npm run start | ||
# or | ||
hugo server -D | ||
``` | ||
5. Open Chrome, web server is available at `http://localhost:<assigned-port-depends>` | ||
- example: `http://localhost:1313` |