Horizen Academy V2
This repository hosts the source code for the Horizen Academy website. You can view the deployed site at horizen.io/academy
Table of Contents
About The Project
This project hosts the source code for the Horizen Academy website. The website is built using Docusaurus 2, a modern static website generator. We're using Cloudflare Pages as our hosting platform.
Technologies Used
Getting Started
Prerequisites
This project requires the following tools:
- Node.js
- npm
Some specific configurations will be required for this project. You can check the details in this guide
Installation
To set up the project on your local machine, follow these steps:
- Clone the repository using SSH:
git clone git@github.com:HorizenOfficial/horizen-academy-v2.git
- Navigate to the project directory:
cd ./horizen-academy-v2
- Install the project dependencies:
npm install
Setup your environment
Create an .env
file at the root, using .env.template
as a template.
Create a file named .env.local
inside the env/
folder. You can use the .env.local.example
file as a guide.
Development
To run the project locally, use the following command:
npm run start
This will start the development server at http://localhost:3000/academy/
Build
To build the project, use the following command:
npm run build
This will build the project into the public
directory.
We currently deploy this project to multiple environments, so we need to specify which build command to run for each environment:
-
build:dev
is used by Cloudflare Pages to build the site for the dev environment. Each time we push a commit to any branch that is notmain
, Cloudflare Pages will create a preview environment for that branch using this command. -
build:prod
is used by Cloudflare Pages to build the site for the prod environment. Each time we deploy to themain
branch, Cloudflare Pages will build the site using this command.
Deployment
Simply commit your changes and push them. Cloudflare Pages will automatically build and deploy your site.
Take a look at the Cloudflare Pages pipeline on Github to get the URL of your deployed site.
More detailed information about the workflow can be found in this guide