Skip to content

Latest commit

 

History

History
91 lines (53 loc) · 4.38 KB

README.md

File metadata and controls

91 lines (53 loc) · 4.38 KB
Raw

Open Source Love svg2 MIT license Website shields.io

Visit the EOS icons website

Guideline to develop this site

In the project directory, you can run:

Setting up

After cloning this repository you will need to install all the dependencies: npm i

Configuration

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/)

Staring up

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.

JS and SCSS quality assurance

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

Build it to ensure it will work on production

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.

How to contribute

Code contributions

  1. Open a new or pick an open issue from the issue list and claim it in the comments. Make sure that the issue is confirmed so you don't work on something that will not be approved to be merged.
  2. Make sure you follow our best practices: refer to our Wiki. You'll find information on writing code, how to name a branch, how we release, etc.
  3. Join Slack [optional] to get in touch with the maintainers if you have any doubt: join slack
  4. Make sure you fork the project, cloning it will not give you the right access to open a PR/MR. How to open a PR in open source

Design contributions

If you'd like to contribute with design changes, you'll have to do as follows:

  1. Open an issue
  2. Add all relevant information to the issue. Please be as descriptive as possible. Add links to references, images, videos, etc.
  3. While working on your design, please make sure you follow our design guidelines.
  4. Once the issue is approved by us, it'll be ready to be implemented.

Adding new icons

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.

Learn more about the EOS UX/UI Solutions

Our "thank you" section

Deployed with Vercel

vercel

Tested for every browser in every device

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.