Core Kit
DOCS
Pre-installation requirements
1. Ask one of management stuff to invite you to the private npm package as developer
2. Open invitation email and proceed account creation flow to npm.
Installation
1. Login to npm
with command:
NPM Docs
npm login
And enter your credentials
Note: to check who is already in npm
system, write npm whoami
2. Install via npm
npm i @gemlightbox/core-kit
IMPORTANT SETUP DETAILS:
1. You must import styles to properly use the library:
import "@gemlightbox/core-kit/dist/assets/styles/index.css";
2. Library requires to use the color pallet defined as css variables. You can use default one by:
- use of the
ThemeProvider
component and wrapping whole app with it (it will require setup which
can be found in the core-kit docs) - or importing light theme directly:
import "@gemlightbox/core-kit/dist/assets/styles/root.css";
- or create your own theme with
theme.css
variables structure
Build with Create React App and Rollup bundler
This project was bootstrapped with Create React App.
Available Scripts
In the project directory, you can run:
npm start
Runs the app in the development mode.
Open http://localhost:4444 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
npm build
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for
more information.
npm build-package
Builds the app for npm deployment to the dist
folder.
Learn More
You can learn more in the
Create React App documentation.
To learn React, check out the React documentation.