Pangea Client

Pangea client web application.

Getting Started

Running

To run the app in the development mode, first set the backend URL:

$ export REACT_APP_METAGENSCOPE_SERVICE_URL=http://127.0.0.1:5000

Make sure you have installed Typings dependencies (TypeScript definitions):

$ npm install typings -g
$ typings install

Then run the app:

$ yarn start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

Development

Developer documentation can be found in docs/.

Pangea uses the GitFlow branching strategy along with Pull Requests for code reviews. Check out this post by the Dwarves Foundation for more information.

This project uses JSDoc, see their Getting Started page if you are unfamilair.

Project Structure

This project follows the Component Folder Pattern. A good overview of the pattern can be found here.

Releases

pangea-client uses standard-version to manage releases.

yarn release

For all options see CLI Usage

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Release History

See CHANGELOG.md.

Authors

• Benjamin Chrobot - Initial work - bchrobot

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.