Content Prototype
๐ง Work in progress
๐งช Staging
The staging site is available on heroku
๐ฒ Installation
System dependencies
- Node.js
v10+
- JavaScript runtime environment. - Ruby
v2.4+
- High level programming language. - Bundler - Ruby application gem bundler
- LibSass - Stylesheet language
For quick start tips per system see System Setup in Contributing.
Application dependencies
bundle install
npm install
๐ฏ Usage
Compile and serve the site
npm start
aliases;
bundle exec nanoc
bundle exec nanoc view
You can now open http://localhost:3000
๐ณ Docker
Run the app in a docker container
docker build -t dfe-content-prototype:latest .
docker run -e PORT=3000 -p 3000:3000 --rm -it dfe-content-prototype
You can now open http://localhost:3000
๐ฆ Deployment
bundle exec nanoc
bundle exec nanoc deploy
๐ค Contributing
We love contributions! View our contribution guidelines.
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
๐ License
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is ยฉ Crown copyright and available under the terms of the Open Government 3.0 licence.