Git Product home page Git Product logo

website-template's Introduction

NOTE: npm commands overwrite the ./public directory.

1. Getting Started

Project's source files are placed in ./src/ directory.

  • ./src/assets - default static files (eg. image placeholders). You should replace them with your own files.

  • ./src/tailwind/ - Tailwind config file used to build the theme. Variables used in Theme Customizer are located in tailwind.config.js file.

  • ./src/*.pug - All your pages (templates) are stored in separated .pug files.

2. Installation

# Install dependencies
npm install 

# Run dev server with live preview (Browsersync)
npm run watch

# Or make a production build 
npm run build

If you want PurgeCSS to delete unnecessary CSS classes (and create a smaller CSS file as a result) set NODE_ENV to production, e.g:

# Make a production build and automatically use PurgeCSS
# to remove CSS classes that aren't used.

NODE_ENV=production npm run build

3. Contact

If you have found any bugs in the Tailwind Builder, have any questions, comments or ideas for new features feel free to contact us:

[email protected]

4. Credits & Special thanks

We use placeholders from:

Icons: https://webkul.github.io/vivid/ Pictures: https://unsplash.com/ Illustrations: https://undraw.co/illustrations

website-template's People

Contributors

granicz avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.