npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

studiokit-scaffolding-js

v7.0.7

Published

Common scaffolding for Studio apps at Purdue

Downloads

192

Readme

studiokit-scaffolding-js

studiokit-scaffolding-js provides a common scaffolding for react apps.

  1. Installation
  2. Usage
  3. Development

Installation

Install this library and call startup methods

  1. yarn add studiokit-scaffolding-js
  2. (Optional) Call configurable extensions in your main entry file
    • redux/sagas/rootSaga
      • setOtherDependentSagas to add more sagas
    • redux/sagas/postLoginDataSaga
      • setOnPostLogin to load more data after login
    • redux/configureReducers
      • updatePersistBlacklist and setOtherReducers to add more reducers
  3. In your main entry file call startup
    import { startup, endpointMappings } from 'studiokit-scaffolding-js'
    
    const appConfig = {/* AppConfiguration */}
    const endpointMappings = {...endpointMappings, .../* App EndpointMappings */}
    const { history, store, persistor } = startup(appConfig, endpointMappings)
    
    // render using history, store, persistor
    ReactDOM.render(
    	...
    )

Styles

Basic Setup

In your project’s startup index.tsx file, import the scaffolding styles as follows

...third party css...

import 'studiokit-scaffolding-js/lib/css/index-with-variables.css'

...project specific css...

In config-overrides.js when setting up react-app-require-postcss, in order for css variables to work, the importFrom array should look like the following:

importFrom: [
	'node_modules/studiokit-scaffolding-js/lib/css/variables.css'
]

Variable Override Setup

In order to override certain color variables from variables.css, they must be overridden before scaffolding’s index.css file is imported.

In your project’s startup index.tsx file, import the scaffolding styles as follows

...third party css...

import 'studiokit-scaffolding-js/lib/css/variables.css'
import './css/variables.css'
import 'studiokit-scaffolding-js/lib/css/index.css'
import './css/index.css'

In config-overrides.js when setting up react-app-require-postcss, in order for css variables to work, the importFrom array should look like the following:

importFrom: [
	'node_modules/studiokit-scaffolding-js/lib/css/variables.css',
	'src/css/variables.css'
]

Usage

Components and Utils

Components and utils can be imported from studiokit-scaffolding-js/lib/...

Development

Branches

  1. Create a new branch
    • Feature/Issue: In GitLab from an issue, create a branch off of develop
    • Hotfix: Create a hotfix branch off of master (manually or in GitLab by making an MR)
  2. Update the version number
    • Feature/Issue
      • append -next.1.1
      • e.g. If the current version is 1.0.0, the new branch should be 1.0.0-next.1.1
    • Hotfix
      • increase the version number and append -alpha.1
      • e.g. If the current version is 1.0.0, the new branch should be 1.0.1-alpha.1 for hotfix
    • NOTE: if more than one branch is being developed on at the same time, simply increment the first number after "next"
      • e.g. 1.0.0-next.2.1 for the second issue branch (this won't apply for hotfixes)
  3. Development Loop
    1. Add/update new components, utils, or styles
    2. Add/update unit tests for those components or utils to confirm basic functionality
    3. Increment the last number in the version
      • e.g. 1.0.0-next.2.1 => 1.0.0-next.2.2 for a feature/issue branch
      • e.g. 1.0.1-alpha.1 => 1.0.1-alpha.2 for a hotfix branch
    4. Push to gitlab. Azure DevOps will run a pipeline and publish this version to npmjs.org
    5. Install the new version in the project(s) you are working on by updating its package.json and running yarn
    6. Repeat as needed
  4. Merging
    • After the Merge Request is approved, remove the "next" or "alpha" suffix from the version before merging to develop or master
    • For hotfix branches, the version number should be the new patch number, e.g. 1.0.1
  5. Release
    • Feature/Issue: After merging, create a new "release" branch from develop and follow the "git flow" release steps as normal
    • Hotfix: Finish the "git flow" hotfix steps as normal from the hotfix branch
    • Azure DevOps will run a pipeline to publish the version merged to master to npmjs.org

Styles

Styles are organized into the following folders and files inside of src/css

  1. variables.css
    • Global constant variables
    • Common app-specific variables
  2. utils
    • Assorted utility styles, similar to tachyons
    • Break out similar styles into separate files once a few similar ones exist
      • e.g. _display.css contains all display: ...; related modifier styles
  3. base
    • _base.css: Generic tags, .skip-main link, and .main-content
    • _typography.css: Default fonts, font scale, and text colors
  4. components
    • Global component specific styles (e.g. not functional like tachyons)

Your project’s css folders and files should follow this same pattern.