Skip to content
This repository has been archived by the owner on Oct 17, 2020. It is now read-only.

Latest commit

 

History

History
55 lines (43 loc) · 1.58 KB

README.md

File metadata and controls

55 lines (43 loc) · 1.58 KB
Raw

Short Ext

Install from Chrome Web Store

Preview

Prerequisites

  • yarn v1.17.3
  • node v12.3.1

Getting Started

Setup

cp .env.dist .env.development

Replace APP_BASE_URL with the URL of the web frontend.

Build

For Local Development

yarn
yarn build:development

For Production Release

Once the wanted changes are merged into master branch, create a release tag with the new version.

Eg. 0.0.7

Install

  1. Navigate to chrome://extensions/ in Google Chrome.
  2. Turn on developer mode.
  3. Click on Load unpacked.
  4. Select build directory.
  5. Short should now up in extension list.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issues with the owner of this repository before making a change.

Pull Request Process

  1. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  2. You may merge the Pull Request in once you have the sign-off of code owner, or if you do not have permission to do that, you may request the code owner to merge it for you.

Author

Harry Liu - byliuyang

License

This project is maintained under MIT license