0.18.2 • Published 4 years ago

@open-raven/react-styleguide v0.18.2

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
4 years ago

openraven

openraven.

Base technology

Publishing

Publishing should already be setup. Just follow these steps to publish the project:

  • commit code
  • run yarn run release:major, yarn run release:minor, or yarn run release:patch to bump the version and update changelog
  • run yarn publish or npm publish

The publishing will be automatically done to CP's jfrog repo based on the config found in the .npmrc file.

Important

  • Make sure you are signed in before publishing or it won't work. Run npm adduser to sign in. Credentials can be found here.
  • Copy the .npmrc file to a new project in which you will install this package. That way you fetch the package from the correct repo when doing npm install or yarn install.

Setup

It's assumed that you will consume this package in an application bundled with Webpack. Follow the steps below:

  1. Activate SVGR Module

    SVGR Add this config to webpack.config

    {
        test: /\.svg$/,
        use: ['@svgr/webpack', 'url-loader'],
    },
  2. Import base styles

    Import the openraven base styles in the app's entry CSS file:

    /* src/index.scss */
    @import '~@open-raven/react-styleguide/styles/index';

    ..or in your entry JavaScript file:

    // src/index.js
    import "@open-raven/react-styleguide/styles/index.scss";
  3. Use the components

    import { Button } from '@open-raven/react-styleguide';
    
    <Button />

    You may take a look at all the components by running the Storybook.

Commands

start

$ npm start

Starts Storybook.

build

$ npm run build

Builds the project.

lint

$ npm run lint

Checks if the project has any linting errors.

test

$ npm test

Runs the project tests.

release

$ npm run release

Releases the package. Runs tests, lints and builds the project beforehand. If successful, you may publish the release to npm by running $ npm publish.

This command uses standard-version underneath. The version is automatically inferred from the conventional commits.

Using a linked version of openraven

In some cases, you may want to make changes to the openraven at the same time as you work on your project which uses the openraven. In order to use a local version of openraven and have any openraven modifications be reflected live on your project, some pages have to be made in your main project.

Some of the instructions below assume you are using Webpack in your main project.

Make required changes to your Webpack config

Before exporting the webpack configuration, add the following line to the file. This will check if there is a linked version of openraven and add aliases to import from the un-compiled files.

const fs = require('fs');
const existsReactStyleGuideSrc = fs.existsSync(path.join(projectDir, 'node_modules/@open-raven/react-styleguide/src'));
const alias = {};

if (process.env.NODE_ENV === 'development' && existsReactStyleGuideSrc) {
  alias['@open-raven/react-styleguide/styles'] = path.join(paths.appNodeModules, '@open-raven/react-styleguide/src/styles');
}

module.exports = {
  resolve: {
    alias,
  },
};

Link openraven to your main project

Two steps: 1) run npm link in this repo 2) update dependent projects by running npm link ../pathToThisRepo inside the root directory of your other projects. 3) when you make a change here that you want to see reflected, you will need to run step 2 again unless you've made the webpack changes for live development.

NOTE: this step has to be retaken every time you run an npm i or yarn commands in your main project, because npm i will replace your linked version with an installed version.

Style Guide Usage

Clone to new project

Follow the instruction below to clone the starter to a new project repo.

Note: we should keep the commit history in the new repo for future rebase.

  • Create a new project repo in bitbucket
  • Clone react-web-starter repo locally, and cd path/react-web-starter
  • Run git remote remove origin
  • Run git remote add origin [new repo url]
  • Run git push origin master -u
  • Verify: should see all the commits history and master branch in new project repo
  • Re-clone react-web-starter repo or reset it's origin if you need to develop against it locally

Rebase your project style guide to include latest changes

  • Create a new branch in your project style guide
  • Run git remote add starter git@bitbucket.org:CodeParticle/openraven.git (The url can be https)
  • Run git fetch starter
  • Run git rebase starter/master
  • Push the branch and open the PR for team review/test before merging

License

Released under the MIT License.

0.18.2

4 years ago

0.18.1

4 years ago

0.18.0

4 years ago

0.17.5

4 years ago

0.17.4

4 years ago

0.17.3

4 years ago

0.17.2

4 years ago

0.17.1

4 years ago

0.17.0

4 years ago

0.16.1

4 years ago

0.16.2

4 years ago

0.16.0

4 years ago

0.15.1

4 years ago

0.15.0

4 years ago

0.14.19

4 years ago

0.14.18

4 years ago

0.14.17

4 years ago

0.14.16

4 years ago

0.14.15

4 years ago

0.14.14

4 years ago

0.14.13

4 years ago

0.14.12

4 years ago

0.14.11

4 years ago

0.14.10

4 years ago

0.14.9

4 years ago

0.14.6

4 years ago

0.14.8

4 years ago

0.14.5

4 years ago

0.14.2

4 years ago

0.14.3

4 years ago

0.14.4

4 years ago

0.14.1

4 years ago

0.14.0

4 years ago

0.13.7

4 years ago

0.13.6

4 years ago

0.13.3

4 years ago

0.13.4

4 years ago

0.13.5

4 years ago

0.13.2

4 years ago

0.13.0

4 years ago

0.13.1

4 years ago

0.12.3

4 years ago

0.12.0

4 years ago

0.12.1

4 years ago

0.12.2

4 years ago

0.11.14

4 years ago

0.11.13

4 years ago

0.11.12

4 years ago

0.11.11

4 years ago

0.11.10

4 years ago

0.11.8

4 years ago

0.11.9

4 years ago

0.11.6

4 years ago

0.11.7

4 years ago

0.11.5

4 years ago

0.11.2

4 years ago

0.11.3

4 years ago

0.11.4

4 years ago

0.11.1

4 years ago

0.11.0

4 years ago

0.10.2

4 years ago

0.10.3

4 years ago

0.10.4

4 years ago

0.9.3

4 years ago

0.10.1

4 years ago

0.10.0

4 years ago

0.9.2

4 years ago

0.9.1

4 years ago

0.8.4

4 years ago

0.9.0

4 years ago

0.8.3

4 years ago

0.8.2

4 years ago

0.8.1

4 years ago

0.7.2

4 years ago

0.8.0

4 years ago

0.7.1

4 years ago

0.7.0

4 years ago

0.5.4

4 years ago

0.6.0

4 years ago

0.5.3

4 years ago

0.5.2

4 years ago

0.5.2-test

4 years ago

0.5.1

4 years ago

0.5.0

4 years ago

0.4.35-test2

4 years ago

0.4.35-test

4 years ago

0.4.34

4 years ago

0.4.33

4 years ago

0.4.32

4 years ago

0.4.31

4 years ago

0.4.30

4 years ago

0.4.28

4 years ago

0.4.29

4 years ago

0.4.26

4 years ago

0.4.27

4 years ago

0.4.25

4 years ago

0.4.24

4 years ago

0.4.22

4 years ago

0.4.23

4 years ago

0.4.20

4 years ago

0.4.21

4 years ago

0.4.19

4 years ago

0.4.18

4 years ago

0.4.17

4 years ago

0.4.15

4 years ago

0.4.16

4 years ago

0.4.14

4 years ago

0.4.13

4 years ago

0.4.12

4 years ago

0.4.11

4 years ago

0.4.10

4 years ago

0.4.9

4 years ago

0.4.8

4 years ago

0.4.7

4 years ago

0.4.5

4 years ago

0.4.6

4 years ago

0.4.4

4 years ago

0.4.3

4 years ago

0.4.1

4 years ago

0.4.2

4 years ago

0.4.0

4 years ago

0.3.40

4 years ago

0.3.39

4 years ago

0.3.38

4 years ago

0.3.37

4 years ago

0.3.36

4 years ago

0.3.35

4 years ago

0.3.34

4 years ago

0.3.31

4 years ago

0.3.32

4 years ago

0.3.30

4 years ago

0.3.29

4 years ago

0.3.28

4 years ago

0.3.27

4 years ago

0.3.26

4 years ago

0.3.25

4 years ago

0.3.24

4 years ago

0.3.23

4 years ago

0.3.22

4 years ago

0.3.21

4 years ago

0.3.20

4 years ago

0.3.19

4 years ago

0.3.18

4 years ago

0.3.17

4 years ago

0.3.16

4 years ago

0.3.15

4 years ago

0.3.14-beta

4 years ago

0.3.13

4 years ago

0.3.12

4 years ago

0.3.11

4 years ago

0.3.10

4 years ago

0.3.9

4 years ago

0.3.8

4 years ago

0.3.7

4 years ago

0.3.0

4 years ago

0.3.6

4 years ago

0.3.5

4 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.3.4

4 years ago

0.3.3

4 years ago

0.2.79

4 years ago

0.2.78

4 years ago

0.2.78-beta.2

4 years ago

0.2.78-beta.1

4 years ago

0.3.1-test

4 years ago

0.2.70-docs

4 years ago

0.2.77

4 years ago

0.2.76

4 years ago

0.2.75

4 years ago

0.2.74

4 years ago

0.2.73

4 years ago

0.2.72

4 years ago

0.2.71

4 years ago

0.2.70

4 years ago

0.2.69

4 years ago

0.2.68

4 years ago

0.2.67

4 years ago

0.2.66

4 years ago

0.2.65

4 years ago

0.2.64

4 years ago

0.2.63

4 years ago

0.2.62

4 years ago

0.2.60

4 years ago

0.2.58

4 years ago

0.2.58-docs

4 years ago

0.2.57-docs

4 years ago

0.2.5-7.docs

4 years ago

0.2.58-beta-2

4 years ago

0.2.58-beta

4 years ago

0.2.57

4 years ago

0.2.56

4 years ago

0.2.56-beta

4 years ago

0.2.55

4 years ago

0.2.54

4 years ago

0.2.53

4 years ago

0.2.52

4 years ago

0.2.51

4 years ago

0.2.50

4 years ago

0.2.49

4 years ago

0.2.48

4 years ago

0.2.47

4 years ago

0.2.46

4 years ago

0.2.45

4 years ago

0.2.44

4 years ago

0.2.43

4 years ago

0.2.42

4 years ago

0.2.41

4 years ago

0.2.40

4 years ago

0.2.39

4 years ago

0.2.38

4 years ago

0.2.37

4 years ago

0.2.36

4 years ago

0.2.35

4 years ago

0.2.34

4 years ago

0.2.33

4 years ago

0.2.32

4 years ago

0.2.31

4 years ago

0.2.30

4 years ago

0.2.29

4 years ago

0.2.28

4 years ago

0.2.27

4 years ago

0.2.26

4 years ago

0.2.25

4 years ago

0.2.24

4 years ago

0.2.23

4 years ago

0.2.22

4 years ago

0.2.21

4 years ago

0.2.20

4 years ago

0.2.19

4 years ago

0.2.18

4 years ago

0.2.17

4 years ago

0.2.16

4 years ago

0.2.15

4 years ago

0.2.14

4 years ago

0.2.13

4 years ago

0.2.12

4 years ago

0.2.11

4 years ago

0.2.10

4 years ago

0.2.9

4 years ago

0.2.8

4 years ago

0.2.8-beta

4 years ago

0.2.7

4 years ago

0.2.6

4 years ago

0.2.5

4 years ago

0.2.5-beta4

4 years ago

0.2.5-beta3

4 years ago

0.2.5-beta2

4 years ago

0.2.5-beta

4 years ago

0.2.4

4 years ago

0.2.4-beta5

4 years ago

0.2.4-beta4

4 years ago

0.2.4-beta3

4 years ago

0.2.4-beta

4 years ago

0.2.3

4 years ago

0.2.2

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.1.17

4 years ago

0.1.16

4 years ago

0.1.15

4 years ago

0.1.14

4 years ago

0.1.13

4 years ago

0.1.12

4 years ago

0.1.11

4 years ago

0.1.10

4 years ago

0.1.9

4 years ago

0.1.8

4 years ago

0.1.7

4 years ago

0.1.6

4 years ago

0.1.5

4 years ago

0.1.4

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.2-beta

4 years ago

0.1.1

4 years ago

0.1.1-beta-7

4 years ago

0.1.1-beta-6

4 years ago

0.1.1-beta-5

4 years ago

0.1.1-beta-4

4 years ago

0.1.1-beta-3

4 years ago

0.1.1-beta-2

4 years ago

0.1.1-beta

4 years ago

0.1.0

4 years ago

0.1.0-beta

4 years ago