github-pages-template

Template which I use to build fast github pages using node.js + react + material-ui

Installation

1. Clone this repository

git clone https://github.com/dunky11/github-pages-template/

2. Install node.js

sudo apt install nodejs

3. Install dependencies

cd github-pages-template
npm install

4. Start local server

npm start

Usage

You can start editing files now, changes will automatically refresh your webpage. Inside config.js you can set basic configuration. Before you deploy your project to github-pages be sure to edit your package.json so "name" and "homepage" matches your projects.

Deployment

1. Compile your project

npm run build

2. Push your compiled project to the gh-pages branch

npm run deploy