Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/programmershri/tailwind-css-starter-postcss
Boilerplate
https://github.com/programmershri/tailwind-css-starter-postcss
ant-design antd css javascript postcss react reactjs redux-toolkit tailwindcss
Last synced: 7 days ago
JSON representation
Boilerplate
- Host: GitHub
- URL: https://github.com/programmershri/tailwind-css-starter-postcss
- Owner: ProgrammerShri
- Created: 2022-02-22T18:48:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-07T19:58:53.000Z (about 2 years ago)
- Last Synced: 2024-11-07T10:47:00.643Z (about 2 months ago)
- Topics: ant-design, antd, css, javascript, postcss, react, reactjs, redux-toolkit, tailwindcss
- Language: HTML
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tailwind CSS as a PostCSS Plugin
A starter template for very simple projects (no frameworks) with Tailwind CSS setup as a PostCSS plugin. You only need to install NPM.
Follow the Getting Started guide and build websites with Tailwind CSS. Also, follow the steps to Optimize for Production to end up with a very tiny final CSS bundle.
## Getting Started
1. Clone the repository
git clone https://github.com/ProgrammerShri/tailwind-css-starter-postcss.git
Alternately you can download the zip file and unzip it.
2. You will now have the cloned project folder. Open the project in
Visual Studio Code editor (recommended code editor for Tailwind CSS
Projects)3. Open new terminal within Visual Studio Code
4. Download and install NPM - [A Beginner’s Guide to npm](https://www.sitepoint.com/npm-guide/)
5. Install dependencies
npm install
6. Build using Tailwind CSS
npm run build
7. Open the `public > index.html` file in your browser and you should see a heading styled with a gradient. If you don't see a gradient on the text, something went wrong.
## How to use
- Go to `public > index.html` Remove the `
` element and start adding your own HTML.
- If you need to add more HTML pages, add them in the `public` folder.
- To extract classes and use the `@apply` directive, edit the custom CSS file in `src > styles.css`. Add any amount of custom CSS within this file. Refer [https://tailwindcss.com/docs/installation#using-a-custom-css-file](https://tailwindcss.com/docs/installation#using-a-custom-css-file)Watch HTML files for changes and build automatically everytime using
npm run watch
NOTE: Do NOT edit the file `public > dist > styles.css` directly - This is the distribution stylesheet. The CSS here is generated from `src > styles.css` using Tailwind when you build.
## Optimize for production
Before pushing your code (the `public` folder) for production, run the below command to reduce the size of `styles.css` within the public folder
npm run prod
NOTE: If you are using Windows and face an error `NODE ENV not recognised`, run the below command
npm install win-node-env