Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 1.08 KB
Raw

Contributing to Omatsuri

Thanks for taking a look at the project and thinking about contributing! I'm always looking forward to add more applications to Omatsuri, improve UX of existing tools and decrease loading time. You are welcome to become contributor and create pull request with any improvements and new features.

Getting started

To start contributing, fork the original repository and clone it to your computer.

To get started with application locally use these commands:

# Install dependencies
yarn

# Start application, browser will open automatically
npm start

After you've finished your changes please create pull request to original repository. I'll review your changes and merge them if everything works fine.

Previewing production builds

Make sure that changes you've made also work in production environment. To setup it locally tun npm run serve script and open prompted url. This script will build project from scratch and serve it on port 6002. It may take some time, so be patient.