Studiokit-scaffolding-js NPM

studiokit-scaffolding-js

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

Installation
Usage
Development

Installation

Install this library and call startup methods

yarn add studiokit-scaffolding-js
(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

In your main entry file call startup

import { startup, endpointMappings } from 'studiokit-scaffolding-js'

const containerElementId = 'root'
const appConfig = {/* AppConfiguration */}
const endpointMappings = {...endpointMappings, .../* App EndpointMappings */}
const { history, store, persistor } = startup(appConfig, endpointMappings, containerElementId)

// render using history, store, persistor
ReactDOM.render(
	...
)

Usage

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

Development

Inside of Scaffolding

Create a feature branch off of develop
Add new components or utils
Add unit tests for those components or utils to confirm basic functionality

Integration in a Local Project

Normally, we would use yarn link to connect a library branch to a project locally, but there are currently limitations with typescript @types where duplicate versions of the types are referenced. Here are some workarounds.

Manual Workaround

Run yarn build to build your changes to scaffolding
Manually copy the lib output folder to _project_/node_modules/studiokit-scaffolding-js/lib to test those changes in your app

Git Built Branch Workaround

This workaround requires a temporary branch where the built lib folder is committed.

From your current feature branch, make a new branch called e.g. feature/my-feature-built, with the -built suffix and switch to it.
yarn build
git add lib -f
git commit -am 'add lib' --no-verify
git push --set-upstream origin feature/my-feature-built --no-verify, using your built branch name
In your project, update package.json with "studiokit-scaffolding-js": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js.git#commit_hash", where commit_hash is the git commit hash of the most recent commit on the current branch and commit & push that change.
yarn install (also in your project)

To make more changes to the built branch:

Make changes to your normal feature branch
Merge changes into the built branch
yarn build
git commit -am 'update lib' --no-verify
git push --no-verify
In your project, update package.json with "studiokit-scaffolding-js": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js.git#commit_hash", where commit_hash is the git commit hash of the most recent commit on the current branch and commit & push that change.
yarn install (also in your project)

After finishing your feature branch, don’t forget to delete the temporary built branch.

1 day ago

1 day ago

2 days ago

3 days ago

2 days ago

2 days ago

6 days ago

6 days ago

8 days ago

8 days ago

7 days ago

9 days ago

12 days ago

12 days ago

13 days ago

13 days ago

15 days ago

19 days ago

16 days ago

21 days ago

21 days ago

20 days ago

20 days ago

21 days ago

27 days ago

27 days ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

7 months ago

11 months ago

11 months ago

11 months ago

9 months ago

8 months ago

11 months ago

11 months ago

8 months ago

8 months ago

8 months ago

11 months ago

9 months ago

8 months ago

8 months ago

8 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago