Bounties Rules:
Projects more than 4 hours, make an issue first for feedback
Projects less than 4 hours, tag us in our Discord with your idea.
Thank you for your efforts!
- pi0neerpat
Under active development
Published dev branch https://keyp-ui-kit-dev.surge.sh/
Published main branch https://keyp-ui-kit.surge.sh/
- Clone the repo and run
yarn installto install the necessary dependencies. Make sure you're using a recent version of node (>= 16.0.0) - Navigate to the root directory of
ui-kitand runyarn tailwindcss. This script ensures our Tailwind styles are built and available to the styleguidist server. - In the same directory, run
yarn start. This script starts the styleguidist server. - Your server should now be running successfully!
Surge is a static web publishing service that lets us easily deploy our frontend components to a live URL.
Currently, our frontend components are deployed to https://keyp-frontend-components.surge.sh/
While testing, if you need a link to send to the design team you can easily deploy to a different link. However, we will keep this link as the code representative of our components currently in production.
This is how you can deploy to surge:
- CD into the
ui-kitfolder - Run
styleguidist buildto generate the styleguide directory with the bundled assets for deploy - Run
surgeand point to the styleguide folder - Should look like
/YOUR_LOCAL_PATH/ui-kit/styleguide - Choose https://keyp-ui-library.surge.sh/ as the domain to deploy the site if you want to deploy a new production build (you can create any other name for the domain if you want to deploy a test build to share with someone)
- If you're unable to deploy to the production domain, send your email to Jacob so he can add you as a collaborator
Copyright ยฉ 2023 Nifty Chess, Inc.
This project is MIT licensed.