Skip to content

hungpm372/coffee-style-ui

Repository files navigation

Coffee HTML Tailwind Template

Introduction

The Coffee HTML Tailwind Template project is a ready-to-use template for developing websites using CoffeeStyle, HTML, and Tailwind CSS. This template helps you get started quickly with a pre-configured structure and integration of popular technologies.

Installation

  1. Clone the project:

    git clone https://github.com/hungpm372/coffee-style-ui
  2. Navigate to the project directory:

    cd coffee-style-ui
  3. Install dependencies:

    npm install

Usage

Development

  1. Run the development server:

    npm run dev
  2. Open your browser at http://localhost:3000 to view your website during development. The website will automatically refresh when you make code changes.

Build (Production)

  1. Build the website:

    npm run build
  2. The built website will be in the public directory. You can deploy it on any suitable platform.

Directory Structure

  • public: Contains the main source code of the project.

    • assets: Resources such as images, fonts are stored here.
    • scripts: CoffeeStyle source code.
    • styles: CSS and Tailwind CSS source code.
    • index.html: Main page of the application.
  • tailwind.config.js: Tailwind CSS configuration.

Customization

  • Customize the homepage in public/index.html.
  • Change the Tailwind CSS configuration in tailwind.config.js.
  • Customize and add your CoffeeStyle, HTML, CSS source code in the src directory.

Contribution

If you want to contribute to the project, open an issue or create a pull request. We welcome community contributions.

Copyright and License

The project is released under the MIT License. You are free to use, copy, modify, and distribute the project under this license.