amanforindia / dyslex.ie

Chrome extension that helps people with dyslexia interact with the Web.

Dyslex-E

This extension makes reading articles easier for those who have dyslexia or other reading ailments. It's estimated that 1 in 10 people are dyslexic. If we make reading even slightly easier, it's a win in our book.

How to access

You can learn more about Dyslex-E by visiting our homepage.

Contributing

We're running on React. You can check out the React components under src/components and the styles we use under src/styles. The app is loaded in at src/content.js, so you can follow the files from there to figure out where everything is.

Bootstrapped with Create React App, and uses this guide and that guide to make things work. You don't have to read these, they're just for reference.

Styles

Our SCSS code is in CSS modules which are automatically minifed on build so that they do not clash with the classes present in normal webpages.

Building

Whenever you make a change, you'll have to rebuild the extension so that the changes you made are compiled down into the extension. Run yarn build to generate a build folder. Then, add the build folder as an unpacked extension in the Chrome extensions page. You should see the extension on your toolbar. Remember to rebuild after you make changes. Happy experimenting!

Try running yarn build-fast to make a development version. Not sure how fast it is - it might be slower - but you take what you can get in this life.

Contributing

Make pull requests or issues as you see fit!