Skip to content

🕸️ Enables fast iteration for GH Pages with React and Tailwind CSS baked in.

Notifications You must be signed in to change notification settings

mxbaylee/github-page-template

Repository files navigation

🤪 Baylee's Open Source Template

This template allows you to build TypeScript React applications that compile to gh-pages easily!

💫 Using this template

Clone the template

git clone git@github.com:mxbaylee/github-page-template.git PROJECT_NAME
cd PROJECT_NAME

Update the port

npm run reroll:port
npm pkg set 'homepage'='/'$(basename "$PWD")

Update git

rm -rf .git
git init
git add --all
git commit -m '🥳 Initial commit'
git remote add origin PROJECT_ORIGIN
git push

Initial deploy

npm install
npm run deploy

💻 Logistically

🤖 To run

npm install
npm start

📦 To deploy

npm run deploy

🕵️🏼 Todo

  • Update public/manifest.json with new app details
  • Update logos
    • public/favicon.ico 16x16
    • public/logo192.png 192x192
    • public/logo241.png 241x241
  • Update package.json with new app details
  • Update readme.md

About

🕸️ Enables fast iteration for GH Pages with React and Tailwind CSS baked in.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published