An open API service indexing awesome lists of open source software.

https://github.com/jclem/template-parcel

A template for frontend development
https://github.com/jclem/template-parcel

Last synced: 5 months ago
JSON representation

A template for frontend development

Awesome Lists containing this project

README

          

# Parcel Template

This repository is a template for tinkering with frontend projects. It uses
[Parcel](https://parceljs.org) to easily bundle up frontend assets that can
be deployed to [Vercel](https://vercel.com/) for sharing.

It makes use of:

- Plain HTML for HTML
- [Tailwind CSS](https://tailwindcss.com) for CSS
- [TypeScript](https://www.typescriptlang.org) for JavaScript
- [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) for basic style and format checks
- [Husky](https://github.com/typicode/husky) for automated pre-commit checks and formatting

## Use

1. Clone: `git clone https://github.com/jclem/tinker.git` and `cd` into `./tinker`
1. Install dependencies: `npm install`
1. Tinker! Edit `src/index.html`, `src/js/index.ts`, and `src/css/index.postcss`.

## Scripts

A number of scripts are in [package.json](package.json) for developing,
building, and deploying:

- `npm run dev` This starts a Parcel development server (with live reload, etc.)
- `npm run build` This simply builds to the "public" directory (which is .gitignore-ed)
- `npm run deploy` This deploys the project to Vercel