Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ismaestro/ampjucks

Boilerplate and base project to create static websites with AMP, Nunjucks and Gulp
https://github.com/ismaestro/ampjucks

amp amp-articles amp-dash amp-html amp-pro amp-starter-theme amp-template base-code base-project boilerplate example-app example-project example-projects example-repo gulp-tasks nunjucks seed template-project templates

Last synced: 2 months ago
JSON representation

Boilerplate and base project to create static websites with AMP, Nunjucks and Gulp

Awesome Lists containing this project

README

        


Ampjucks


Base project to built a website with AMP, Nunjucks and Gulp





Demo example



Report bug
·
Request feature


## Table of contents

- [Features](#features)
- [Quick start](#quick-start)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Creators](#creators)
- [Copyright and license](#copyright-and-license)

## Features

* Real template from AMP Start project (e-commerce)
* Nunjucks templates
* Gulp tasks for development server, watch changes, livereload, minify files, clean dist folder, etc
* Free template
* Internationalization
* SASS support. Files separated and mixed and minified with gulp tasks
* Sitemap autogenerated

## Quick start

`npm i` - Installs everything needed

`npm run start` - Runs the server and watch for file changes in src folder. localhost:8000

`npm run build` - Creates dist folder ready to deploy it

`npm run validate` - Validate all html files inside dist folder to be AMP valid

Dist folder:

Build task creates two different folders with the HTML files one per language. Deploy this folders the way you like the most.

* If you use Webstorm, see [this](https://github.com/mozilla/nunjucks/issues/472).

## Bugs and feature requests

Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/Ismaestro/ampjucks/blob/master/CONTRIBUTING.md) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/Ismaestro/ampjucks/issues/new).

## Creators

**Ismael Ramos**

-

Buy Me a Coffee at ko-fi.com

## Copyright and license

Code and documentation copyright 2011-2018 the authors. Code released under the [MIT License](https://github.com/Ismaestro/ampjucks/blob/master/LICENSE).

Enjoy :metal: