Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidperis92/pug-example-project
Pugjs example project
https://github.com/davidperis92/pug-example-project
bem bootstrap4 example-project gulp jquery pug pugjs scss
Last synced: about 16 hours ago
JSON representation
Pugjs example project
- Host: GitHub
- URL: https://github.com/davidperis92/pug-example-project
- Owner: davidperis92
- License: mit
- Created: 2018-10-17T08:31:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-09T10:47:35.000Z (about 6 years ago)
- Last Synced: 2024-11-06T18:00:23.072Z (about 2 months ago)
- Topics: bem, bootstrap4, example-project, gulp, jquery, pug, pugjs, scss
- Language: CSS
- Homepage:
- Size: 9.87 MB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pugjs Example Project
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
You need gulp, and npm to run and build the project.
```
npm install -g gulp
```
### Installing
Use npm install to download all the dependencies.
```
npm install
```
## Development
Use gulp to start the development server.
```
gulp
```
### Templates
The templates are made with Pug and there are located in app/src/templates, you can get the docs of it's page: https://pugjs.org/
### Styles
The css class names must be in spanish. We use BEM with prefixes:
- p- : Pages
- l- : Layouts
- c- : Components
- g- : General
- u- : Utilities
- h- : Helpers
- i- : Icons
### Scripts
We use ES6 for the scripts (are transpiled to ES5 by babel).
The scripts are located inside app/src/js. In the folder root are located the scripts that are excuted when the user moves between sections.
- app.js: This is the main script, the shared and intro vars are created here.
## Build
Use gulp dist to generate a zip in project folder.
```
gulp dist
```