Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/daerogami/nunjucksstarterproject

Starter Project for Creating Component-based Website Mockups
https://github.com/daerogami/nunjucksstarterproject

mockups nunjucks starter-project template-project

Last synced: about 1 month ago
JSON representation

Starter Project for Creating Component-based Website Mockups

Awesome Lists containing this project

README

        

# Nunjucks Starter Project

Starter Project for creating component-based website mockups

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

** *This project is not designed to be deployed to a production environment.* **

### Prerequisites

[nodejs](https://nodejs.org/en/)

[Gulp](https://gulpjs.com/): Be sure to globally install first!

[VSCode](https://code.visualstudio.com/): Highly recommended but not required.

### Installing

Open a terminal and navigate to the root of the project and install the npm dependencies.

```
npm i
```

Run gulp to build the project (and rebuild on any updates)

```
gulp
```

Start express to view the site from a local browser

```
gulp serve
```

## Deployment

This project is not intended for deployment to a public-facing server.

## Built With

* [Nunjucks](https://mozilla.github.io/nunjucks/) - Templating engine

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

* **Mark Clark** - *Project Creator*

See also the list of [contributors](https://github.com/daerogami/NunjucksStarterProject/graphs/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details