publication

This is the Publication application to display publication information at dictyBase.

Cloud Native Development

All dictyBase development is now done with cloud native development in mind. It is expected that you have your own Kubernetes cluster running. Documentation for the cloud deployment process can be found at the dictyBase Developer Docs.

To deploy an application manually, you can leave a /deploy comment inside of a pull request or issue.

Local Development

In order for this application's login system to work locally, you will need to configure the list of providers.

Copy the provided sample clientConfig.sample.ts file to clientConfig.ts in the same folder.
Add any provider names and their corresponding client IDs.
All providers should have a matching counterpart in the oauthConfig.ts file. Enter all of the configuration parameters for every new provider in that file.

After setting up the login providers, you can run yarn and yarn start as usual.

Backend Requirements

This app requires the following services to be running:

Application Structure

.
├── public                      # Index.html and favicon
├── src                         # Application source code
│   ├── app                     # Application level components
│       ├── actions             # Actions used for the entire app (i.e. footer, navbar)
│       ├── layout              # Main app template
│       ├── reducers            # Redux reducers
│       ├── routes              # React Router routes
│       ├── store               # Redux store configuration
│   ├── common                  # Common features for entire app
│       ├── @types              # Typescript type definitions
│       ├── assets              # Images, fonts, etc.
│       ├── components          # Generic components
│       ├── constants           # Static data (i.e. footer, navbar links)
│       ├── utils               # Application utilities
│   ├── features                # Main features of application
│       ├── Authentication      # Authentication-related components
│       ├── Publication         # All components related to publication retrieval/display
│   └── index.tsx               # Application rendering
└──                             # Config files