A starter template for web projects

• Node.js (LTS or newer).
• NPM (comes included with Node.js) or Yarn.

$ cd ~/dev/
$ npx degit astraloverflow/starter-web#2023.4.28 my-new-website
$ cd my-new-website
$ npm install
$ npm run dev

• Runs stylelint (see .stylelintrc.js) and eslint (see .eslintrc.js) to check files for syntax and coding style errors.
• Runs tsc --noEmit to check typescript types and compliation errors

• Runs Prettier to format all code to the same style. See Prettier website for full list of supported languages. Best used with the Prettier plugin for your chosen editor.

• Runs Parcel in development mode and runs a development server.

• Runs Parcel in production mode and builds the project.

Unless you want to release your project into the public domain via CC0 (which this project does), you should replace the contents of LICENSE with a license of your choosing (MIT, BSD, GPL, etc.)

Inside of .gitignore you will find the following

# These files lock down the project's node dependencies
# These are only here for the development of starter-web
# You should remove whichever one you are using in your project
package-lock.json
yarn.lock

As the comment in the file says, you should remove one of those two lines if you want to use the "version locking" features of either one, especially if you are developing with other people or on multiple computers/servers or are using a CI.

It is highly recommended that you customize package.json with the details of your project, mainly the following fields:

{
  // Prevents your project from unintentionally being published to NPM.
  "private": true,
  // SPDX license identifier for your project's license.
  // The list of SPDX license identifiers can be found here: https://spdx.org/licenses/
  "license": "",
  // Your project's version number, as seen by NPM.
  "version": "0.0.0",
  // Your project's name, as seen by NPM. See NPM docs for allowed characters.
  "name": "starter-web",
  // Your project's description, as seen by NPM. Can be left blank.
  "description": "",
  // URL to your project's code repository.
  // If hosted on GitHub you can use the shorthand "user/repo"
  "repository": ""
}