Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joelanman/express-prototype-win
https://github.com/joelanman/express-prototype-win
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/joelanman/express-prototype-win
- Owner: joelanman
- Created: 2014-05-20T14:33:52.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-05-20T14:34:37.000Z (over 10 years ago)
- Last Synced: 2024-04-15T12:13:13.580Z (7 months ago)
- Language: CSS
- Size: 11.5 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Express prototyping tool
Prototyping tool built in [Express](http://expressjs.com/).
It will give you a basic Express app, with templates, css and images from the [GOV.UK front-end toolkit](https://github.com/alphagov/govuk_frontend_toolkit).
## Requirements
* [Node](http://nodejs.org/)
You may already have it, try:
```
node --version
```
Your version needs to be at least v0.10.0.
## Getting started
* Clone this repo.
* If you don't have Node, download it here: [http://nodejs.org/](http://nodejs.org/).
* Run the app:
```
node start.js
```
* Go to [localhost:3000](http://localhost:3000) in your browser.
### Hot reload
Any code changes should update in the browser without you restarting the app.
The app recompiles app/assets/stylesheets/application.scss everytime changes are observed.
## Documentation
Guides for getting set up and how to work with the prototyping application are available on this repo's [wiki](https://github.com/tombye/express_prototype/wiki).
* [Getting started](https://github.com/tombye/express_prototype/wiki/Getting-started) (Read this first)
* [Creating routes](https://github.com/tombye/express_prototype/wiki/Creating-routes)
* [Making pages](https://github.com/tombye/express_prototype/wiki/Making-pages)
* [Writing CSS](https://github.com/tombye/express_prototype/wiki/Writing-CSS)
* [Tips and Tricks](https://github.com/tombye/express_prototype/wiki/Tips-and-Tricks)
This project is built on top of Express, the idea is that it is straightforward to create simple static pages out of the box. However, you're not limited to that - more dynamic sites can be built with more understanding of Express. Here's a good [Express tutorial.](http://code.tutsplus.com/tutorials/introduction-to-express--net-33367)
## Sass Disclaimer
This app uses the [lib-sass](https://github.com/hcatlin/libsass) implementation of Sass to compile its CSS. It's still a work in progress so is missing a few features.
The one that may effect you is the lack of support for [@extend-only selectors](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#placeholders). This means the you can't use [@extend %contain-floats](https://github.com/alphagov/govuk_frontend_toolkit/blob/master/stylesheets/_shims.scss#L45) from the toolkit.
This is explained in more detail [on the wiki](https://github.com/tombye/express_prototype/wiki/Writing-CSS#wiki-we-use-node-sass).
If you need to use the Ruby version of Sass, Run the app like so:
```
node start.js --ruby
```