Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eclectic-coding/vite-vanilla-js-template
https://github.com/eclectic-coding/vite-vanilla-js-template
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/eclectic-coding/vite-vanilla-js-template
- Owner: eclectic-coding
- License: mit
- Created: 2024-08-23T11:51:48.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T11:56:57.000Z (24 days ago)
- Last Synced: 2024-12-03T12:39:23.243Z (24 days ago)
- Language: SCSS
- Size: 495 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vite Vanilla JS Template
Initially built for personal use, I created this template for starting a new project with Vite.js and Vanilla Javascript. It is already set up with standard development tools like ESLint and Prettier for easy code formatting and linting, with Vite for a robust, modern build process.
## Dependencies
This template uses the following dependencies:
- **[Vite](https://vitejs.dev/):** A next-generation frontend build tool that offers a fast dev server and optimized builds.
- **[ESLint](https://eslint.org/):** An open-source JavaScript linting utility that helps maintain a consistent code style.
- **[Prettier](https://prettier.io/):** An opinionated code formatter that enforces a consistent style across your project.
- **[eslint-config-airbnb-base](https://www.npmjs.com/package/eslint-config-airbnb-base) and [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier):** ESLint configurations adhering to Airbnb's base JS style guide and disabling stylistic rules that might conflict with Prettier.
- **[eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import) and [eslint-plugin-prettier](https://www.npmjs.com/package/eslint-plugin-prettier):** ESLint plugins that enforce ES2015+ import/export syntax and integrate Prettier with ESLint.
- **[autoprefixer](https://www.npmjs.com/package/autoprefixer) and [postcss](https://postcss.org/):** Autoprefixer automatically adds vendor prefixes to CSS, while PostCSS provides a way to transform CSS with JavaScript.
- **[cssnano](https://cssnano.github.io/cssnano/):** A tool that helps to compress and optimize CSS files.
- **[postcss-nesting](https://www.npmjs.com/package/postcss-nesting):** A PostCSS plugin that allows you to use modern CSS Nesting in your stylesheets.
- **[vite-plugin-eslint](https://www.npmjs.com/package/vite-plugin-eslint):** Integrates ESLint into the Vite build process for on-the-fly linting.
## Cloning
1. To start using this template, clone the repository with this command:
```bash
git clone https://github.com/eclectic-coding/vite-vanilla-js-template.git
```
2. Then proceed to the folder and install dependencies:
```bash
cd vite-vanilla-js-template
npm install
```
## Post-Cloning Steps
After cloning the template, make sure to clean up and update the following:
1. Remove the .git directory and run `git init` to clean the commit history.
2. Clean up the README.md file.
3. Adapt the LICENSE file to your project.
4. Edit your styles from `src/styles/main.scss`.
5. Adapt the `package.json` file with your project's own information.
6. Delete the .github folder.
## Scripts
Use the following scripts for your development workflow:
```bash
# Start the development server
yarn dev
# Checks your code for any linting errors
yarn lint
# Tries to automatically fix any linting errors present in your code
yarn lint:fix
# Formats your code in a consistent, predefined style using Prettier
yarn format
# Build for production
yarn build
# Preview the build
yarn preview
# Build and preview the project
yarn buildpreview
```
## Folder Structure
This is the structure of the project:
```plaintext
/
├── .github # Github actions and workflows
├── node_modules # Node.js dependencies for the project.
├── public # Public assets and resources
├── src # Source code
│ ├── assets # General assets for your project
│ │ ├── images # Store your images here
│ ├── js # Javascript files of your project
├── main.js # Main Javascript file
│ ├── styles # CSS styles for your project
├── _reset.scss # CSS reset file
├── main.scss # Main SCSS file
├── .editorconfig # Configuration for the EditorConfig plugin
├── .eslintignore # Files to be ignored by ESLint
├── .eslintrc.json # Configuration for ESLint
├── .gitignore # Files and folders to be ignored by Git
├── .prettierignore # Files to be ignored by Prettier
├── .prettierrc # Configuration for Prettier
├── index.html # The HTML file for your project
├── LICENSE # The license for your project
├── package.json # Defines your project and its dependencies
├── postcss.config.cjs # Configuration for PostCSS
├── README.md # This file
├── vite.config.js # Configuration for Vite
├── yarn.lock # Lockfile for your project's dependencies
```
## License
This template was created under the [MIT License](LICENSE.md).
**Happy coding!** 👨💻