This is a simple site, bootstrapped with Create React App that uses Bootstrap 4 for a CSS framework.
This project is setup for easy deploying for hosting on Github Pages, perfect for when you're just squatting a landing page cause you're a domain hoarder.
- Clone this repo
git clone
- Run
npm install
to install dependencies - Run
npm start
to launch dev site http://localhost:3000/
Script | Description | Additional Documentation |
---|---|---|
npm start |
Will run the local development server | Create React App |
npm run build |
Will build the production site code to the ./build/ directory |
Create React App |
npm run deploy |
Will run build and deploy the build to the gh-pages branch |
|
npm test |
Runs tests (not fully implemented) | Create React App |
This repo is setup to deploy to the gh-pages
branch for hosting using the domain name defined in /public/CNAME
.
Run the deploy NPM command to run a production build and push that to the gh-pages
branch immediately.
npm run deploy
Additional resources on DNS configuration & domain setup:
If the build isn't running on the deployment environment, and you see a white screen of death (WSOD) it may be due to a mismatch in whether the URL is accessing the project in a sub directory and if at access URL matches the directory structure defined in /package.json
under the key homepage
.
For example if there is no domain defined in CNAME and you try to access the repo via https://user.github.io/repo-name
then you'll need to use 'homepage': 'https://user.github.io/repo-name'
then when the CNAME is setup from the DNS provider. When the deploy is setup with the domain name you'll need to deploy a new build with updated homepage
key.
This section has moved here: facebook.github.io/create-react-app/docs/troubleshooting