Code Monkey home page Code Monkey logo

vite-vanilla-project-starter's Introduction

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

vite-vanilla-project-starter's People

Contributors

ronwaller avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

sathish39893 eugen-regner arturdsm

vite-vanilla-project-starter's Issues

fix: Usage section

Use "src" folder to place all code.
The vite.config.js file tells vite to run project from this folder and build to dist folder.
Once new project is setup and dependencies install delete images folder and README
Use README-template to create project readme

Fix README logic

  • Remove all mention of Clone repo
  • Put Installation section into collapse area
  • Move screen shot below Installation heading

Fix README content

  • Turn images into links
  • Change repository into template
  • Add instructions how to use template
  • remove Images folder

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.