BYOB.css

BYOB.css is an starter CSS framework built for Mintbean Learnathon #82 - Build Your Own Bootstrap.

Local deployment

This project uses yarn workspaces. You'll need to install yarn in order to deploy this locally. Yarn is actually an amazing dev tool and has really neat features like caching, which makes yarn install MUCH faster than npm.

(You don't have to install yarn. But you might have to fiddle around with npm link if you don't! Be warned.)

Once you've installed yarn, you can do:

yarn install
yarn start

That's it! Then you should be able to visit the project at http://localhost:1234.

Github Pages deployment

This project is set up to deploy directly to your Github Pages. Your project will build and deploy from the /docs folder. Here's the official documentation on how to set up your Github Pages.. To get started, you can simply fork the project.

How this project is structured

This project uses yarn workspaces to stitch two separate JS projects together. They are:

  • packages/byob-css, a lightweight core CSS framework that can be imported into any SCSS-enabled project. You can start reading this project from packages/byob-css/src/index.scss. We're using parcel-bundler to bundle things together for this app. If you want to push your framework to NPM, you should probably look into replacing this with Rollup.

  • packages/byob-css-example, an example kitchen sink. It's VERY raw. You can start reading this project from packages/byob-css-example/index.html.

See the example project in action.

The live version of the sample app can be seen here. It's very raw, and most projects will probably expand this seed project into a full kitchen sink.

That's it. Best of luck!