9Rooftops Framework

Project Description

This project is an ongoing WIP for a full framework that can be used on all 9Rooftops websites. This framework should include simple styling to allow for full creative control.

Setup local development

The following steps will help in setting up the local environment for this project.

$ cd ~/projects/
$ git clone [email protected]:9rooftops/9r-framework.git
$ cd ~/projects/9r-framework
$ lando start

Local env settings

The local env is built using Lando and controlled by the .lando.yml config file. The env utilizes node and grunt to watch, compile sass and js files. The lando start command will fire off the env build and upon completion the grunt watch task will be started as well.

The build process will install all needed apps and add the required items to the package.json file. Any further extending or tooling that is needed should be added to the lando.yml file and the "lando rebuild -y" command should be run to test the new edits before pushing to the code repo.

Local env files

The following files control the local env and watch settings and should be included in the repo for all users.

.lando.yml
Gruntfile.js
package.json

Contributing

For major changes, create a branch that you will work in. Once fully tested, the branch can be merged into master.

Updating NPM package

Once updates have been approved and merged into master, they can be merged into the npm-package branch. This branch has a few minor edits to allow for projects to pull in and override where needed. Be sure to update the following file were needed.

Increment the version number.

package.json

Add new components

/source/scss/9r-framework.scss

You will need to add any newly created components to this file so they will be part of the build process.

You can then submit the package via the following command.

lando npm publish --access public

Change Log

Software Requirements

• Docker
• Lando
• GIT
• GitKraken -optional

License

• MIT