Running the Handbook Locally
The handbook is part of the Nx build system monorepo. Follow these simple steps to install and run it locally:
Steps to Run the Handbook
Configure ebrains-ui-monorepo
Before you get started with running the handbook locally, you need to make sure the ebrains-ui-monorepo project is configured and run successfully. To verify the configuration, please follow the steps here
Ensure Hugo Extended Version is Installed
Now, that we have verified the installation and the configuration of the ebrains-ui-monorepo, check that Hugo extended is installed:
- Linux devices:
See detailed instructions here.
- Mac devices:
See instructions here and decide your installation type (brew, build from source etc.)
Check that Hugo is installed correctly by verifying the version:
Run the Handbook
Serve the handbook locally using the following command:
You should see: Web Server is available at http://localhost:3333/
Developing and deploying for other environments in Nx requires a few more .env.[xyz] files to be configured. You can look at .env.local.example to get an idea.