@envato-foundation/foundation-design-system

Foundation Design System

Foundation Design System is a collection of design tokens, components and guidelines for building cohesive UI systems within parts of Envato.

Status: Work in Progress.

Table of Contents

• Developer Setup
• Versioning
• Documentation Deployment
• Creating Design Tokens
• Using the Design System
• Contributing
• Maintainers
• Code of Conduct
• License

Developer Setup

In order to set up the project locally follow these steps:

• Clone the repository: git clone [e-mail]:envato/foundation-design-system.git
• Install dependencies: npm i
• Watch (and automatically build): npm start
• Preview the site at localhost:3000.

The project has been bootstrapped with Create React App and the following files must exist in order to build the sites correctly:

• index.html: the page template
• src/favicon.ico: the icon representing the site in the browser tab
• src/index.js: the JavaScript entry point.

Remember to always base your feature branch off of master.

Publishing to NPM

Read the Publishing guide on how to version and publish modules to NPM.

Using the Design System

Read the How to Use Guide for possible installation options for the Foundation Design System within your project.

Creating Design Tokens

Read our Creating Design Tokens Guide.

Contributing

Please familiarise yourself with our Contributing Guidelines to make the contribution process easy and effective for everyone involved.

Maintainers

• Fraser Xu
• István Huszár
• Jordan Lewis
• Karolina Szczur
• Paweł Gałązka

Code of Conduct

This project adheres to the Contributor Covenant Code Of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [e-mail].

License

MIT