Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
FabriceSpahn committed Nov 30, 2023
0 parents commit 4013b7f
Show file tree
Hide file tree
Showing 18 changed files with 10,764 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[production]
> 1%,
last 4 versions
ie >= 10
124 changes: 124 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Ignore these files
node_modules/
public/

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

#custom
dist/
.DS_Store
3 changes: 3 additions & 0 deletions .htmlnanorc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"minifySvg": false
}
5 changes: 5 additions & 0 deletions .postcssrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"plugins": {
"autoprefixer": {}
}
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Naman Gupta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
![Built With Parcel](https://img.shields.io/badge/Built%20With-Parcel-yellow?style=for-the-badge)

Read detailed blog on how and why to use at - [https://dev.to/insanenaman/starter-kit-for-static-websites-52hl](https://dev.to/insanenaman/starter-kit-for-static-websites-52hl)

## Parcel Static Website Starter

### Features 🚀

1- Compatible with All Static Site like Bootstrap Template

2- Out of the box Uglifying/ Minifying of CSS, HTML, JS

3- SCSS Support

4- ES6+ Support

5- Hot Reloading

6- Runs on a local server

7- Auto prefixing - Support IE10 and last 4 versions of all browsers

### How to use 🧐

`Make sure you have node installed. If not, I recommend installing via` [nvm(Node Version Manager)](https://github.com/nvm-sh/nvm)

1- Put your code in `src` folder

> There are sample files already present (feel free to delete them and add yours) to give you an idea about the architecture. You only to care about just one file i.e, `index.html`. You need to put at the `src` (`src/index.html`) folder level.
2- Install necessary packages - `npm i` or `yarn`

3- Run project (Development) - `npm run start` or `yarn run start`

4- Build(If you ready to deploy) - `npm run build` or `yarn run build`

### Commands available 🛠:

There are only three commands

1- `npm run start` - It starts a local server so that you can work on your project without any hustle. Enjoy Hot reloading (Live Updates in browser) and SASS/SCSS support.

2- `npm run build` - When you are ready to deploy. You can build your project and deploy the `dist` folder made by this command.

3- `npm run reset` - It just cleans `dist` (output folder) and `.cache` folder. Run this command before starting work on a new project. Parcel caches some files for the faster builds so its good to remove them before switching project.

### Advanced 👽

1- `.browserslistrc` - Default configuration targets IE-10 as well. If you don't want to support IE then you can delete configuration from this. Read more [here](https://github.com/browserslist/browserslist#browserslist-)

2- `.postcssrc` - This file is responsible to manage PostCSS plugin. This file can configure CSS plugins like AutoPrefixer, CSS Modules etc. Read more [here](https://parceljs.org/css.html#postcss)

3- Everything- This project has been built on top of [Parcel](https://parceljs.org). You can configure completely as you want.

### Creator 😈

Its Naman Gupta, FullStack Product Developer and FOSS lover.

Find me on [Twitter](https://twitter.com/InsaneNaman), [Linkedin](https://linkedin.com/in/InsaneNaman), [Dev.to](https://dev.to/InsaneNaman) and check out my [Portfolio](https://insanenaman.com)
Loading

0 comments on commit 4013b7f

Please sign in to comment.