https://github.com/romaixn/boilerplate-vite-twig

Boilerplate with Twig / Bootstrap / SCSS / jQuery
https://github.com/romaixn/boilerplate-vite-twig

boilerplate scss template twig vitejs

Last synced: 2 months ago
JSON representation

Boilerplate with Twig / Bootstrap / SCSS / jQuery

• Host: GitHub
• URL: https://github.com/romaixn/boilerplate-vite-twig
• Owner: Romaixn
• Created: 2022-06-24T12:34:49.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-10-24T10:50:20.000Z (2 months ago)
• Last Synced: 2024-10-25T09:26:15.260Z (2 months ago)
• Topics: boilerplate, scss, template, twig, vitejs
• Language: Twig
• Homepage:
• Size: 416 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
Boilerplate Vite Twig


  


    Boilerplate with Twig / Bootstrap / SCSS / jQuery

  




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





    View Demo

   · 

    Documentation

   · 

    Report Bug

   · 

    Request Feature

  






# :notebook_with_decorative_cover: Table of Contents

- [About the Project](#star2-about-the-project)

  * [Features](#dart-features)

- [Getting Started](#toolbox-getting-started)

  * [Prerequisites](#bangbang-prerequisites)

  * [Run Locally](#running-run-locally)

  * [Deployment](#triangular_flag_on_post-deployment)

- [Contributing](#wave-contributing)

- [Contact](#handshake-contact)

## :star2: About the Project

### :dart: Features

- Build assets using Vite.js

- Twig support

- Bootstrap support

- jQuery support

## 	:toolbox: Getting Started

### :bangbang: Prerequisites

This project uses Yarn as package manager

```bash

 npm install --global yarn

```

### :running: Run Locally

Clone the project

```bash

  git clone https://github.com/Romaixn/boilerplate-vite-twig.git

```

Go to the project directory

```bash

  cd boilerplate-vite-twig

```

Install dependencies

```bash

  yarn install

```

Start the server

```bash

  yarn dev

```

### How to add pages ?

#### Create the twig file

Create a twig file in the templates folder with this minimal content:

```twig

{% extends "base.html.twig" %}

{% block body %}

    Your content here

{% endblock %}

```

> The content of the page will go between the `block body` and the `endblock`

#### Create the html file

Add the page in .html format to the root of the project. (next to index.html and about.html) With this minimal content:

```html

{

}

```

> Replace `name-of-your-page` by the name of your template

You can add any variables you want in JSON. (a list of items for use in loop, the title of the page, etc..)

#### Adding output for production build

Add your page in `vite.config.js` file in the root of the project.

### :triangular_flag_on_post: Deployment

To build your assets run

```bash

  yarn build

```

## :wave: Contributing



  



Contributions are always welcome!

See `contributing.md` for ways to get started.

## :handshake: Contact

Romain Herault - [@Romaixn](https://twitter.com/romaixn)

Project Link: [https://github.com/Romaixn/boilerplate-vite-twig](https://github.com/Romaixn/boilerplate-vite-twig)