This is the source code for the Buildit website: https://buildit.wiprodigital.com/
To provide feedback, raise bugs or request features, please use our Buildit website feedback form.
If you want to get involved in the development of this website, then please see our contribution guidelines.
Node v8.10.0 or higher is required.
If you use NVM for managing Node, you can just issue the following command to install the right node version
$ nvm install
and before running any other npm command, run
$ nvm use
There are three ways to build and run the website:
| Script | Description |
|---|---|
npm run build |
Generates a minified local build |
npm run start |
Generates a minified local build and a local server instance |
npm run dev |
Generates a non minified local build and a local server instance |
Local hosting is at http://localhost:8080 and a browser window should open automatically.
Distribution goes into ./dist.
Refer to the build process document for further details on all the tasks the build performs.
All commits should be made with Commitizen. To make your commits with it simply run the following command.
npm run commit
Failure to format your commits properly will result in a rejected PR and/or failed cloud builds.
Some of the files produced by the build, for example sitemap.xml, need to contain the website's absolute URL. Others, such as robots.txt, need to have different contents depending on where the build will be deployed to (so that we can prevent search engines indexing our staging environments).
To facilitate this, multiple environments can be defined in the envs section of config.json. Both the npm start and npm run-script build commands support an additional --env argument which takes the name of the desired environment for that build as its parameter (note that you need to proceed it with -- so that npm passes that argument through to the underlying build script). For example:
$ npm run-script build -- --env production
Where production corresponds to the key of the desired environment defined in config.json:
{
// ...
"envs": {
"production": {
// The absolute URL that this site is deployed to
"url": "https://buildit.foo.bar",
// Whether or not search engine bots should be
// prevented from indexing this site
"excludeRobots": true
},
"other-env": {
// ...
},
// ...
},
// ...
}If no --env argument is provided to the builds, then the first environment defined in config.json will be used.
For complete info see our branching strategy docs. The basic premise is that master is always correct and deployed, develop is used for creating feature branches and to then merge in to master. next is "special" and is used to build and test the next big version of the app.
The app will auto-deploy to production using Travis with every passing merge to master.
It will also auto-deploy to the next environment with every passing merge to the next branch.
- Contribution guidelines
- Coding standards
- Branching strategy
- Testing
- Build process
- Build and deploy pipeline
- Flourish design elements to use, extend or create the flourish component
Behind the scenes the website is using the following technologies, so be sure you know what you're doing before starting to change anything.
- Metalsmith for the core of the website,
- HandlebarJS as templating engine,
SCSS, with the addition of- Cypress, for end-to-end testing
- Pa11y-CI, for automated accessibility
Decisions linked to implementation details, have not been catalogued. Many of those decisions are now lost.
Therefore, although late, we have decided to start logging all new decisions. These decisions will now be catalogued in the Decision Log