thumper
A customized version of bootstrap with customized for use with Go Nimbly projects and extended with new custom component styles.
Features
â Subjectively better looking than bootstrap!
â Scoped version for inclusion in environments that already have css we don't want to override.
â Webpackable js or css
â Sourcemaps
â Only one file to include
â Font Awesome optional
Installation: Webpack project
npm install @gonimbly/thumper --save-dev
If you're using webpack then you can add import 'thumper'
or require('thumper')
to your project but you will also need a style-loader entry in your webpack config.
If you would like to use Font Awesome icons in your project then add the latest cdn link or install via npm.
Directory Layout
.
âââ /bin/ # Build scripts
âââ /node_modules/ # 3rd-party libraries and utilities _generated_
âââ /components/ # Documentation components
âââ /deploy/ # Deployment folder, _generated_
âââ /dist/ # Production build folder _generated_
âââ /pages/ # React.js-based Documentation pages/styles
â âââ /examples/ # Documentation examples, can be mixed and matched into pages
â âââ /img/ # Documentation example images
âââ /public/ # Development build folder _generated_
âââ /src/ # Thumper src files
âââ /views/ # Server-side views
âââ app.js # The main Documentation JavaScript file (entry point)
âââ server.js # Server configuration / settings
âââ package.json # Dev dependencies and NPM scripts
Getting Started with development
Just clone the repo, install Node.js modules and run npm start
:
$ git clone git@bitbucket.org:gonimbly/thumper.git
$ npm install
$ npm start
App will open http://localhost:3000/ in your browser.
How to Test
There are no tests, we should add some
How to Deploy
$ npm run deploy