- Copy
.env.example
to.env
and fill in with relevant information - Copy
.env.development.example
to.env.development
and fill in with relevant information (default should be fine for dev) - Run
npm install
- Run
npm run dev
and open the URL printed in the terminal (typicallyhttp://localhost:3000
)
The project uses gh-pages for deployment. gh-pages is a utility that helps you easily deploy a project to GitHub Pages from the command line. It simplifies the process of deploying static websites (like React, Vue, Angular apps, or other static assets) by automating the process of pushing your build files to the correct branch (gh-pages or a specified branch) on GitHub.
- Make sure the
.env
exists in root directory and has all relevant information - run
npm run gh
to both build and deploy the project