Skip to content

RonWaller/vite-vanilla-project-starter

Repository files navigation

Vite Vanilla JS Banner

Vite Vanilla Project Builder

This repository will help create a boilerplate vanilla javascript project using Vite. When downloading the repo locally all future projects can be created just by copying and renaming folder your project name.

Dev Dependencies

Vite babel/core babel/eslint-parser babel/preset-react types/node Typescript typescript-eslint/eslint-plugin typescript-eslint/parser eslint eslint-config-airbnb eslint-config-airbnb-typescript eslint-config-prettier eslint-config-wesbos eslint-plugin-html eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks Prettier


Tech Stack

Client: HTML, SCSS, Javascript

How to Use

  • Use the 'src' folder for all project files.
    • HTML
    • JS
    • SCSS
  • vite.config.js file sets up project input to 'src' folder.
  • Use eslintrc file to configure linting rules
  • Use prettierrc file to configure formatting rules
  • Once new project has been setup and dependencies installed delete image folder and README
  • Rename README_template to README for project

Installation

Instructions

Use template

repo from template

  1. Use this template
  2. Name the repository
  3. Write a short description
  4. Create Repository from Template

zip download screen shot

  1. Download Zip File
    • Click Code Button (1)
    • Download Zip (2)
  2. Unzip file
  3. Move folder to project location
    • Rename folder to project name OR
    • Copy repo folder
    • Rename folder to project name

Open Terminial

  • Navigate to projects folder

Install dependencies

  npm install

Start the dev server

  npm run dev

Build Project

To build for production

  npm run build

Open in Editor (VS Code)

  code .

Now delete README and create new from README_template


License

License: MIT