Welcome to Bedrock.
Bedrock is a powerful tool that lets you prototype complex web applications and document design systems.
For the full documentation, please check out the Bedrock website.
- First, make sure you have Node 10 or later installed. You can find the latest version of Node at Nodejs.org. Go for the LTS version.
Using Bedrock to make prototypes
Create your first prototype
We recommend using degit to be able to grab a Bedrock install without actually cloning the project repository (see: Contributing to Bedrock).
Here is the series of commands to use:
npm i -g degit degit usebedrock/bedrock my-bedrock-project cd my-bedrock-project/ npm install npm start
For the Bootstrap 4 base, use the following commands:
npm i -g degit degit usebedrock/bedrock#bootstrap4base my-bootstrap-project cd my-bootstrap-project/ npm install npm start
For Material design, use the following:
npm i -g degit degit usebedrock/bedrock#materialbase my-material-project cd my-material-project/ npm install npm start
Contributing to the Bedrock project
Read the active issues on Github.
Clone this repository:
git clone email@example.com:usebedrock/bedrock.git
The latest development usually happen in feature branches or in the
Make sure to make a branch for yourself - and if you have something meaningful to contribute, send us a PR!
Contact the authors
- Johan's DM inbox is open for questions: https://twitter.com/wolfr_2
npm start: runs the prototype
npm run build: create a build (which ends up in the
distfolder) that can be deployed to a server
Upgrading your Bedrock prototype is done through a CLI tool, which you install globally.
npm i -g bedrock-cli bedrock upgrade
To upgrade to the development branch:
bedrock upgrade --dev
See the README at https://github.com/mono-company/bedrock-cli .
Using icon fonts
- If you want to use icon fonts you need more dependencies than just node. Icon font generation is optional. Set
bedrock.config.jsto activate icon fonts.
- In order for the icon font generation to work, install the required gems using
bundle install. You will need Bundler for this. We depend on a Ruby gem called
fontcustom. Bundler will install the required dependencies.
Windows usage is not supported at the moment.
We have used Bedrock on Windows successfully though. If you encounter any Windows related bugs, please log them under issues.
Bedrock is MIT licensed.