https://github.com/aarongarciah/parcel-static-boilerplate

📦 Simple starter to write HTML, JS, and SCSS right away with no additional config.
https://github.com/aarongarciah/parcel-static-boilerplate

autoprefixer babel boilerplate eslint imagemin jamstack nunjucks parcel prettier sass scss static-site static-site-generator stylelint

Last synced: 4 months ago
JSON representation

📦 Simple starter to write HTML, JS, and SCSS right away with no additional config.

• Host: GitHub
• URL: https://github.com/aarongarciah/parcel-static-boilerplate
• Owner: aarongarciah
• License: mit
• Created: 2019-03-24T09:21:52.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:27:57.000Z (almost 2 years ago)
• Last Synced: 2024-09-27T07:44:07.659Z (4 months ago)
• Topics: autoprefixer, babel, boilerplate, eslint, imagemin, jamstack, nunjucks, parcel, prettier, sass, scss, static-site, static-site-generator, stylelint
• Language: Nunjucks
• Homepage: https://parcel-static-boilerplate.netlify.com/
• Size: 1.56 MB
• Stars: 19
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Parcel Static Boilerplate

[![Actions Status](https://github.com/aarongarciah/parcel-static-boilerplate/workflows/CI/badge.svg)](https://github.com/aarongarciah/parcel-static-boilerplate/actions)

[![Known Vulnerabilities](https://snyk.io/test/github/aarongarciah/parcel-static-boilerplate/badge.svg?targetFile=package.json)](https://snyk.io/test/github/aarongarciah/parcel-static-boilerplate?targetFile=package.json)

[![Netlify Status](https://api.netlify.com/api/v1/badges/b634f3a6-0192-4258-8e27-54fa8a6d1e67/deploy-status)](https://app.netlify.com/sites/parcel-static-boilerplate/deploys)

Simple starter to start writing HTML, JS, and SCSS right away with no additional config. Can be used as a static site generator!

## Development

1. **Clone** or [download](https://github.com/aarongarciah/parcel-static-boilerplate/archive/master.zip) this repository.

   ```

   git clone https://github.com/aarongarciah/parcel-static-boilerplate.git

   ```

2. **Install** dependencies.

   ```

   npm install

   ```

3. **Run** dev mode. It will open a browser tab with the dev url [`http://localhost:1234/`](http://localhost:1234/).

   ```

   npm run dev

   ```

## Production build

Run the build script and the optimized for production website will be generated in the `/dist` folder.

```

npm run build

```

## Serve production build locally

If you want to serve your production build (the generated `/dist` folder) locally just run this command and open [`http://localhost:5000/`](http://localhost:5000/) in your browser. This command runs the `npm run build` command before serving the `/dist` folder.

```

npm run serve

```

## Tech stack

- [Parcel](https://parceljs.org/)

- [Babel](https://babeljs.io/)

- [ESLint](https://eslint.org/)

- [Prettier](https://prettier.io/)

- [Sass](https://sass-lang.com/)

- [Autoprefixer](https://github.com/postcss/autoprefixer)

- [Stylelint](https://stylelint.io/)

- [Nunjucks](https://mozilla.github.io/nunjucks/)

- [Imagemin](https://github.com/imagemin/imagemin)

## To do

- [ ] Detail all features: linting, formatting, building, etc.

- [ ] Add all available commands.

- [ ] Explain why there are two `/static` folders.

- [ ] Warn against how Parcel treats the `site.webmanifest` file.

- [ ] Explain how to config Imagemin.

- [ ] Explain how to config Nunjucks.

- [ ] Find a good Nunjucks code editor formatter.

- [ ] Add recommended extensions for development.

- [ ] Add testing setup with Jest?