Skip to content

dictyBase/dicty-stock-center

Repository files navigation

Dicty Stock Center

License
GitHub tag GitHub action
codecov This project is using Percy.io for visual regression testing. Maintainability
CodeFactor Last commit
Funding

This is the repository for the new Dicty Stock Center.

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 here.

The general workflow is to cut a feature or fix branch (see Gitflow Workflow) then open a pull request when it is ready to merge into develop. We have a CI pipeline set up with GitHub Actions that will run unit tests, type checking, ESLint and other tasks for every pull request. When those checks pass, the branch can then be merged into develop.

Every merge into develop will trigger a workflow that builds a new Docker image based on that commit, pushes it to Docker Hub, then upgrades the corresponding pod in your cluster.

Local Development

In order for this application to work locally, you will need to configure the list of login 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. Fill up all of the configuration parameters for every new provider in that file.

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

Backend Requirements

This app requires the following services to be running:

Further Documentation

There is a static site available for react-styleguidist documentation.

More documentation can be found in the docs folder.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Eric Hartline

🐛 💻 📖 🎨 🚧 ⚠️

Siddhartha Basu

🐛 💻 📖 🚧 ⚠️ 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!

Misc badges

Issues Open Issues Closed Issues
Total PRS Open PRS Closed PRS Merged PRS
Commits Branches Tags
GitHub repo size GitHub code size in bytes Lines of Code