LogoLogo
HomeGitHubComponents
v1
v1
  • 🏃‍♂️Getting started!
  • 📝Customising pages
  • 🛤️Adding more pages
  • 🔡Custom fonts
  • 🎨Theme customization
  • 🎇Restyling components
  • 📣Favicon and Meta Tags
  • 🌐Custom domain name
Powered by GitBook
On this page
  • Overview
  • Step by step guide

Getting started!

NextCustomising pages

Last updated 1 year ago

Overview

Let's start with an overview of what we are trying to achieve.

Let's check how is setup.

The code of the website lies on a of the . The files that are actualy served by lies on the branch and is put there using .

Step by step guide

Open a new terminal (for example )

# Only if you don't have yarn already 
# (you need https://brew.sh to run the next command)
brew install yarn

#
git clone https://github.com/<user_name>/<project_name> <project_name>_landingpage 
cd <project_name>_landingpage

git checkout --orphan landingpage && git rm -rf .
yarn create react-app . --template gitlanding

git add -A
git commit -m "Initial commit"
git push --set-upstream origin landingpage

If you don't have it already, .

Open a Powershell terminal

git clone https://github.com/<user_name>/<project_name> <project_name>_landingpage 
cd <project_name>_landingpage

git checkout --orphan landingpage
git rm -rf .
yarn create react-app . --template gitlanding

git add -A
git commit -m "Initial commit"
git push --set-upstream origin landingpage
# Using Ubuntu
sudo su
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
# Using Debian
su root
curl -fsSL https://deb.nodesource.com/setup_16.x | bash -
####
apt-get install -y nodejs
npm install -g yarn

Open a new terminal

git clone https://github.com/<user_name>/<project_name> <project_name>_landingpage  
cd <project_name>_landingpage

git checkout --orphan landingpage && git rm -rf .
# If you get: 'yarn: error: no such option: --template' running the following command. It means you have 'yarn' from cmdtest, we need yarn the package manager.
yarn create react-app . --template gitlanding

git add -A
git commit -m "Initial commit"
git push --set-upstream origin landingpage

Next you'll have to enable GitHub page in your repo. Navigate to your repository on Github and go to Setting > Pages, then set the gh-pages branch as the branch from witch the site is to be built.

You may need to wait a few minutes for the initial gh-pages branche to be created by your GitHub Action workflow .github/workflows/deploy.yaml

If all went as expected you page should be up and running

You're now ready to customise your app.

If you don't have installed allready:

🏃‍♂️
the landingpage of GitLangind itself
dedicated branch
GitLanding repo
GitHub Page
gh_pages
this GitHub Action
iTerm2
install Node.js
the yarn package manager
https://github.com/USERNAME/REPO/settings/pages