Skip to content

Zequez/frontend-workshop

Repository files navigation

Frontend Workshop

Instead of configuring and storing frontend tooling for each project I create, I built this workshop that has the following things included:

  • Vite for bundling and dev server
  • Eleventy.js for compiling and building static pages
  • Included frameworks: React, Vue, Elm
  • Pug for HTML templates
  • WindiCSS
  • TypeScript by default
  • Automatic deploy script for Github Pages
  • YAML

New apps are then added to /apps/<app_name> and I don't need to install anything or configure any tooling, I can just have a clean repo with only the essential app code.

Features wishlist

  • Graphical UI to manage apps, dependencies and deployments.
  • PWA support
  • Fix the way WindiCSS works in which it accumulates classes until I restart the dev serve
  • Fix favicon not loading
  • Other deployment strategies such as IPFS
  • Automatically update DNS settings on Cloudflare

Usage

Create a new app at /apps/<app_name>

Development

APP=AppName yarn dev

Production build

APP=AppName yarn build

If you want to serve the production files locally for testing

APP=AppName yarn serve

Deploy to Github pages

Make sure you include a CNAME file on the root of the app with the domain name you want. Then configure the domain name on your registrar to point to Github pages to point to your-username.github.com

APP=AppName yarn deploy

The mechanism is detailed on the scripts/deploy.js script.

Ensures that the /dist/<app_name> directory has an initialized git repo on the gh-pages branch with the remote pointing the same as apps/<app_name> git repo.

Then it makes a commit and pushes the changes.

Default app

Add .env file with APP=AppName

About

Workshop to build web apps without having to configure all the same front end tooling over and over again for each one

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors