Beshai Web Quickstart - Full

Quickly spin up web-based prototypes using modern javascript, webpack, and tailwind.

Extends beshai-web-quickstart-basic by adding in Tailwind CSS and a few convenient webpack loaders.

Features

basic webpack configuration with HTML template and public files copied over
webpack-dev-server with easy configuration of hot module reloading
barebones eslint configuration that defers to prettier
prettier configured
jsconfig provided to integrate better with VS Code
optional absolute imports by prefixing with src. e.g. import bar from 'src/foo/bar'
css is extracted into its own file, autoprefixed, purged down to only what has been used
tailwindcss is set-up
css modules are supported by importing foo.module.css or similar
loaders for images, fonts, CSVs have been added so you can import them directly in the js

Installation

Download a zip of this repo then run npm install.

You can copy and paste the following to install. It will prompt you for a project name which sets the name of the directory created:

echo -n "Enter project name: " && read projectName
curl -Lk https://github.com/pbeshai/beshai-web-quickstart-full/archive/master.zip -o beshai-web-quickstart-full.zip && \
  unzip beshai-web-quickstart-full.zip && \
  rm beshai-web-quickstart-full.zip
mv beshai-web-quickstart-full-master $projectName
cd $projectName
npm install

Run the dev server

npm run start

Build for production

npm run build

You can then check out the production build by running a web server in the build directory. A simple way to do so is to use the provided start:prod script:

npm run start:prod

Deploying

There are many options to easily deploy your prototype including Surge and Netlify, but this repo comes configured for easy deploys to github pages. After pushing your repo to GitHub, just run

npm run deploy

Your app will be available at https://username.github.io/repo.

Linting and Code Formatting

Linting and code formatting is provided via the lint and prettier scripts. I have my editor configured to automatically run prettier on save, but if you want to run it manually you can run:

npm run prettier

You may also consider setting up a git hook with husky to make eslint and prettier run automatically on commits.

Remove Tailwind CSS

If you'd prefer not to use Tailwind, you can remove it by:

npm uninstall tailwindcss --save
Delete tailwind.config.js
Remove @tailwind lines from src/index.css
Remove require('tailwindcss') from postcss.config.js

License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

pbeshai / beshai-web-quickstart-full Goto Github PK