Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.45 KB

01-project-layout.md

File metadata and controls

26 lines (20 loc) · 1.45 KB
Raw

Project layout

This project is structured as a multi-package repository. There are three packages:

  1. packages/core,
  2. packages/desktop, and
  3. packages/web.

Core

core is the primary source of the application. It primarily exports a React component: the BioFile Finder application. It also exports a function for instantiating the Redux store to be used with the application, as well as some other interfaces and constants that are helpful within the packages that render the application.

Making use of "core"

Both desktop and web depend on core. They are responsible for rendering the React component exported by core and wiring it together with its Redux store. They may optionally define services that implement interfaces defined within core. These select interfaces are made available for implementation outside of core because they are identified as being "platform-dependent," meaning we may accomplish implementing the interfaces differently within Electron than within a traditional web browser--or we may opt to not implement a service within one of those platforms altogether.

Why the split

The reasoning behind the split in packages is simple: it allows the application to be distributed both as a desktop application (internal-facing, more richly featured), which is the published artifact of desktop, and as a web application (external-facing, feature-limited), which is the published artifact of web.