Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaizau/rapid-prototyping
"Man is a tool-using animal. Without tools he is nothing, with tools he is all." — Carlyle
https://github.com/kaizau/rapid-prototyping
jamstack netlify parcel-bundler posthtml taiwindcss vercel
Last synced: 10 days ago
JSON representation
"Man is a tool-using animal. Without tools he is nothing, with tools he is all." — Carlyle
- Host: GitHub
- URL: https://github.com/kaizau/rapid-prototyping
- Owner: kaizau
- Created: 2018-11-09T08:48:10.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T08:50:21.000Z (10 months ago)
- Last Synced: 2024-11-06T23:05:52.506Z (about 2 months ago)
- Topics: jamstack, netlify, parcel-bundler, posthtml, taiwindcss, vercel
- Language: JavaScript
- Homepage: https://rapid-proto.vercel.app
- Size: 1.26 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rapid Prototyping Template
> Goal: a simple, get sh\*t done toolkit.
**Opinionated takes:**
- React, Vue, and other SPA frameworks are overkill for 90% of projects.
- Adding tests or TypeScript before you have user traction is about as restrictive as wearing a
tuxedo / evening gown to a triathlon.
- Expect to throw this version away and rewrite it The Right Way™ after you figure out what you're
actually building.
- When in doubt, follow [sane defaults](https://github.com/elsewhencode/project-guidelines).
## Installation
Expects globally-installed [`degit`](https://github.com/Rich-Harris/degit#readme) and one of either
[`vercel`](https://vercel.com/docs/cli) or [`netlify-cli`](https://docs.netlify.com/cli/get-started/).
1. Clone template with `degit kaizau/rapid-prototyping `
2. Install dependencies with `npm i`
3. Copy `.env.example` to `.env` to assign variables
## Usage
Use one of the commands below to start a development server on `localhost:8888`.
```sh
npm start # static server
npm run vercel # static server + vercel functions
npm run netlify # static server + netlify functions
```
Deploy to Vercel or Netlify using the respective CLI tool or git CI. You can
also inspect a production build locally:
```sh
npm run build # build to dist
npm run analyze # build + bundle analysis
```
## Notes
- [Parcel](https://parceljs.org/) is the _least bad_ bundler out there, and
provides a simpler local development experience than alternatives.
- Cache-busting hashes, minification, transpiling... all of these happen
automatically using sensible defaults.
- Module resolution automatically routes absolute paths to the project root.
- [EJS](https://ejs.co/) adds JS templating to static HTML.
- [PostCSS](https://github.com/postcss/postcss) is included to support
[Tailwind](https://tailwindcss.com/), which provides a pragmatic foundation
for layout and styling.
- Local development scripts have been configured to be roughly identical.
- A local middleware proxy is to emulate clean URLs (no ".html" extension).
- Only reason to use `npm run (vercel|netlify)` is for local serverless
functions.