Gemlightbox Core Kit
Installation steps
Following steps will allow you to run the project locally
- Check your node version. It should be at least ^16. up to ^18.
node -v
git clone git@bitbucket.org:picupmedia/core-kit.git
cd core-kit
- Enter you git credentials
git config user.name "YOUR_NAME"
git config user.email "YOUR_EMAIL"
- More likely you would like to go to development branch
git checkout origin development
npm i
- Start the project locally
npm run start
Usage steps
Following steps will describe you how to use deployed npm
package
-
Ask your management stuff to invite you to the private npm package as developer.
You will receive invitation on your email and should proceed to account creation flow to npm
-
Login to npm in your terminal (due to package is private)
npm login
- Enter your login ( not email! ) and password
- After login, you can check whether you logged under you account by following command
npm whoami
- If you want to log out, or you were logged in as another account, you can do:
npm logout
- After that, you can open your project where you want to use it and write:
npm i @gemlightbox/core-kit
// If you try to do that being not logged under valid npm account - you will see 401 Unauthorized error.
- You must import these styles in root of your application to properly use the library:
import "@gemlightbox/core-kit/dist/assets/styles/index.css"; <-- compiled css
import "@gemlightbox/core-kit/dist/assets/styles/root.css"; <-- css variables
- Now you can use all logic exported from core-kit and reuse it in your applications
- Happy coding!
Available Scripts
In the project directory, you can run:
npm run start
Open http://localhost:4444 to view it in the browser
Runs the docs app in the development mode
Here you can see and play with components templates
npm run build
Builds the docs app with all templates for production to the build
folder
Those folder will be deployed to firebase hosting here
You can share with your team, so they can see what components we have and how they behave
npm run build-package
Builds the app as package for production to the dist
folder
Those folder will be deployed to npm private package
here
You need access to it due to it is private package
Bitbucket Pipelines Docs
Please, check bitbucket-pipelines.yml file to check what CI/CD currently
executed
See Learn More for details
Bitbucket Variables Docs
FIREBASE_PROJECT
& FIREBASE_TOKEN
- used to be able to deploy documentation to firebase
hosting by bitbucket pipelines. See Learn MoreNPM_TOKEN
- used to be able to publish @gemlightbox/core-kit
package by bitbucket pipelines to
npm
. You need automation token of user with access to @gemlightbox/core-kit
. See
Learn More
Learn More
To learn React, check out the React documentation
You can learn more in the
Create React App documentation
See the section about create-react-app
deployment for more information
See information about how to install firebase
See information about firebase token
See information about
firebase project ID
See information about npm tokens here and
here
See information about bitbucket pipelines
here and
here
See information about bitbucket cache
here