Skip to content

Commit

Permalink
Merge branch 'master' into MattIPv4/scope-styles
Browse files Browse the repository at this point in the history
  • Loading branch information
MattIPv4 authored Jan 23, 2024
2 parents 29d03f7 + 51635d6 commit b664027
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@ Customized Bulma styling for DigitalOcean Community tools.

## Development/Building

To setup the build/develop environment, you will need to run `npm i` with Node 12+ installed.
This will install the dependencies to allow you to build the project.

If you wish to build the styles to CSS, simply run `npm run build`.
This will output `style.css` into `build`.
To setup the build/develop environment, you will need to having Node.js installed (matching the version specified in
`.nvmrc`), and then run `npm ci` to install dependencies (this will respect the lockfile).

We make use of `sass-lint` to maintain code quality in the SCSS files.
To run this you can use `npm run lint`.
To run this you can use `npm test`.

To test the project fully, we first run the linter and then build the SCSS to ensure it is valid.
This is achieved with `npm test`.
A demo project is included in the `demo` directory, which helps ensure the styles are working as expected.
This can be run with `demo:dev` to start a server with hot reloading, or `demo:build` to build the demo project.

## Usage Example

Expand All @@ -29,7 +26,7 @@ This styling package is being used in the [DigitalOcean Community DNS tools](htt
### [`src/components`](./src/components)

This directory contains all the styling components that are available within `.do-bulma`.

### [`src/globals`](./src/globals)

This directory contains all the styling that is applied to the whole page.
Expand Down

1 comment on commit b664027

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit has been deployed to DigitalOcean Spaces for easy reviewing.

do-bulma (Build Analysis Report)

Please sign in to comment.