Visit the EOS icons website
In the project directory, you can run:
After cloning this repository you will need to install all the dependencies: npm i
Run cd src && cp config.example.json config.json
Open the new created /src/config.json
with your favourite editor and change the ICON_PICKER_API_URL
variables to point to your instance of Icon API (http://localhost:3131/)
Then run: npm start
to run the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Before submitting a PR/MR make sure your code is compliant with our JS rules by running: npm run test:js
You can format it automatically by running: npm run format
.
To make sure your SCSS/SASS is compliant run: npm run test:sass
If you encounter any deploy error in JS try fixing it by running : npm run js:fix
npm run 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.
If you'd like to contribute with design changes, you'll have to do as follows:
If you'd like to add new icons, you'll need to head over to the icons repository where you'll find thorough instructions on how to design & add icons to the iconic font.
Thanks to Browserstack and their continuous contribution to open source projects, we continuously test the EOS to make sure all our features and components work perfectly fine in all browsers. Browserstack helps us make sure our Design System also delivers a peace of mind to all developers and designers making use of our components and layout in their products.