aarongarciah / parcel-static-boilerplate Goto Github PK

View Code? Open in Web Editor NEW

19.0 3.0 2.0 1.59 MB

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

Home Page: https://parcel-static-boilerplate.netlify.com/

License: MIT License

JavaScript 6.90% SCSS 12.53% Nunjucks 80.57%

parcel boilerplate babel eslint prettier stylelint autoprefixer nunjucks sass scss

parcel-static-boilerplate's Introduction

Parcel Static Boilerplate

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

Development

Clone or download this repository.

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

Install dependencies.
```
npm install
```
Run dev mode. It will open a browser tab with the dev url 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/ in your browser. This command runs the npm run build command before serving the /dist folder.

npm run serve

Tech stack

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?

parcel-static-boilerplate's People

Contributors

Stargazers

Watchers

Forkers

daniepetrov jackiegable

parcel-static-boilerplate's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

An in-range update of husky is breaking the build 🚨

The devDependency husky was updated from `3.0.9` to `3.1.0`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

husky is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ build (13.x): There are 2 failures, 0 warnings, and 0 notices.
❌ build (12.x): There are 2 failures, 0 warnings, and 0 notices.
❌ build (10.x): There are 1 failures, 0 warnings, and 0 notices.

Release Notes for v3.1.0

Add pre-merge-commit hook (#605)

Commits

The new version differs by 5 commits.

436ca18 3.1.0
795508d add funding field
2b601d2 Add pre-merge-commit (#605)
3a844a6 Update README.md
abcb11a update ISSUE_TEMPLATE.md

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

An in-range update of lint-staged is breaking the build 🚨

The devDependency lint-staged was updated from `10.0.7` to `10.0.8`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

lint-staged is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ build (13.x): There are 2 failures, 0 warnings, and 0 notices.
❌ build (12.x): There are 1 failures, 0 warnings, and 0 notices.
❌ build (10.x): There are 2 failures, 0 warnings, and 0 notices.

Release Notes for v10.0.8

10.0.8 (2020-02-25)

Bug Fixes

do not drop backup stash when reverting to original state fails (f589336)
evaluate functional configuration only once (abe4b92)

Commits

The new version differs by 3 commits.

b3c2ffd Merge pull request #798 from okonet/fixes
f589336 fix: do not drop backup stash when reverting to original state fails
abe4b92 fix: evaluate functional configuration only once

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Enable Parcel multiple entry points

Right now, the entry point of the app is the src/index.njk file. That means that only files referenced in the src/index.njk. For example, the src/about.njk is not being processed because is not referenced inside the src/index.njk.

Solution
Change the dev script in the package.json to use every .njk file directly under the src/ folder as an entry point.

-"dev": "NODE_ENV=development parcel src/index.njk --open",
+"dev": "NODE_ENV=development parcel src/*.njk --open",

Problems
Using a multiple entry point, when running the npm run dev script Parcel opens url http://localhost:1234/ but a 404 error is shown, which is very confusing and can lead people to think that the development server is not working properly. Parcel has an opened issue regarding this parcel-bundler/parcel#1315.

The expected behaviour is that http://localhost:1234/ shows the generated index.html, just like when we're using a single entry point for Parcel.

A workaround could be to remove the --open param to avoid Parcel opening automatically http://localhost:1234/ and open manually http://localhost:1234/index.html to avoid the confusion for developers.