Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NateBaldwinDesign/proportio

Tool for creating proportional scales for typography, iconography, spacing, and components in design systems.
https://github.com/NateBaldwinDesign/proportio

Last synced: 2 days ago
JSON representation

Tool for creating proportional scales for typography, iconography, spacing, and components in design systems.

Awesome Lists containing this project

README 

        
# Proportio



_**Tool for creating proportional scales for typography, iconography, spacing, and components in design systems.**_



![GitHub](https://img.shields.io/github/license/NateBaldwinDesign/Proportio)



## Purpose



Making systematic design faster and easier by use of generative, parametric design. Proportio enables designers to use proportional scales to create:



- Type scales

- Icon scales

- Spacing scales

- Component sizes

- Component padding

  and more.



## MLP todo list



(Minimum loveable product)



- [x] Modularize states & clean up props

- [x] Add Feather icons for choosing sample icon: https://github.com/feathericons/feather

- [x] Add variable stroke scale input

- [x] Add google fonts picker for text

- [x] Add density columns

- [x] Add export/ save data or CSS, which compiles options into organized code styles

- [x] Add example UI? Cards, tables, controls

- [x] Add contribution guidelines

- [x] Documentation



Future additions:



- [ ] Clean up code

- [ ] Add “round to even numbers” option

- [ ] Add mobile scale factor

- [ ] Add mobile or responsive type & icon scales

- [ ] Enhanced typography controls (fluid type, long-form type demos)

- [ ] URL sharing option

- [ ] Mobile friendly design



## Development



This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).



### Available Scripts



In the project directory, you can run:



#### `npm start`



Runs the app in the development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.



The page will reload when you make changes.\

You may also see any lint errors in the console.



#### `npm test`



Launches the test runner in the interactive watch mode.\

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.



#### `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](https://facebook.github.io/create-react-app/docs/deployment) for more information.



#### `npm run eject`



**Note: this is a one-way operation. Once you `eject`, you can't go back!**



If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.



Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.



You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.



### Learn More



You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).



To learn React, check out the [React documentation](https://reactjs.org/).



#### Code Splitting



This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)



#### Analyzing the Bundle Size



This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)



#### Making a Progressive Web App



This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)



#### Advanced Configuration



This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)



#### Deployment



This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)



#### `npm run build` fails to minify



This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)