Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 220b78a

Browse files
committed
add basic readme detail
1 parent d592345 commit 220b78a

File tree

1 file changed

+50
-8
lines changed

1 file changed

+50
-8
lines changed

README.md

Lines changed: 50 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,57 @@
44

55
**An opinionated workflow for building modern Jamstack (static) websites**
66

7-
* Author: [Phil Lennon](https://phil.dev)
8-
* Source: [github.com/fephil/jamstack-website](https://github.com/fephil/jamstack-website)
9-
* Issues and Suggestions: [github.com/fephil/jamstack-website/issues](https://github.com/fephil/jamstack-website/issues)
10-
* Twitter: [@frontendphil](https://twitter.com/frontendphil)
11-
* Email: [enquiry@phil.dev](mailto:enquiry@phil.dev)
12-
* Trello Life List [http://bit.ly/life-list](http://bit.ly/life-list)
7+
- Author: [Phil Lennon](https://phil.dev)
8+
- Source: [github.com/fephil/jamstack-website](https://github.com/fephil/jamstack-website)
9+
- Issues and Suggestions: [github.com/fephil/jamstack-website/issues](https://github.com/fephil/jamstack-website/issues)
10+
- Twitter: [@frontendphil](https://twitter.com/frontendphil)
11+
- Email: [enquiry@phil.dev](mailto:enquiry@phil.dev)
12+
- Trello Life List [http://bit.ly/life-list](http://bit.ly/life-list)
1313

14-
***
14+
---
1515

1616
## About
1717

18-
TBA
18+
jamstack-website is a deliberately minimal workflow designed to quickly build a static website using the latest modern techniques and technologies in Frontend development. It is _very_ fast. Use this as a base, fork it and tailor to your specific needs.
19+
20+
This workflow contains:
21+
22+
- Eleventy
23+
- Esbuild
24+
- Postcss
25+
- Tailwind
26+
- Eslint
27+
- Prettier
28+
29+
This workflow isn't designed for use as a single page app architecture such as Vue.js, however you can use javascript to augment pages if needed.
30+
31+
Comments, suggestions & pull requests are always welcome. See the [issues list](https://github.com/fephil/jamstack-website/issues) for more information about future enhancements and changes.
32+
33+
## Requirements
34+
35+
- Node 14 LTS or Node 16
36+
- NPM 7 (however, if package-lock.json is deleted, Yarn or NPM 6 can be used)
37+
38+
### Optional Requirements
39+
40+
In your code editor of choice, the following plugins are recommended but not required. Please note the plugin names might be slightly different depending on your editor. Installing these plugins will help keep a consistent code structure in your project.
41+
42+
- editorconfig,
43+
- eslint,
44+
- prettier,
45+
46+
## Usage
47+
48+
You can run the following tasks in your terminal:
49+
50+
`npm run develop`
51+
52+
This tasks builds the project, enables the website to be viewed in your web browser and will automatically reload when files change.
53+
54+
`npm run build`
55+
56+
This tasks builds the project, checks the javascript for errors, minifies all files and produces a folder (\_site) ready for deployment.
57+
58+
## Licence
59+
60+
MIT

0 commit comments

Comments
 (0)