https://github.com/dictybase/dictyaccess
Dashboard for data visualization in dictyBase applications
https://github.com/dictybase/dictyaccess
circos graphql react
Last synced: 6 months ago
JSON representation
Dashboard for data visualization in dictyBase applications
- Host: GitHub
- URL: https://github.com/dictybase/dictyaccess
- Owner: dictyBase
- License: bsd-2-clause
- Created: 2020-09-18T14:23:37.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-09T06:52:53.000Z (7 months ago)
- Last Synced: 2024-11-09T07:33:02.949Z (7 months ago)
- Topics: circos, graphql, react
- Language: JavaScript
- Homepage: https://dictybase.github.io/dictyaccess/
- Size: 15.8 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 93
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dictyaccess
[](#contributors-)
[](LICENSE)
[](https://codecov.io/gh/dictyBase/dictyaccess)
[](https://codeclimate.com/github/dictyBase/dictyaccess)
[](https://reporter.nih.gov/project-details/10024726)
This is the [dictyAccess](https://dictycr.org/dictyaccess) data visualization dashboard application.
## Cloud Native Development
All dictyBase development is now done with cloud native development in mind. It is expected
that you have your own [Kubernetes](https://kubernetes.io/) cluster running. Documentation
for the cloud deployment process can be found [here](https://github.com/dictyBase/Migration/tree/master/deployment).
The general idea is that after every git commit a new Docker image is built based on that commit,
pushed to Docker Hub, then the corresponding Helm chart is upgraded with that image tag
inside 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](src/common/utils/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.js](src/common/utils/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 `npm install` and `npm start` as usual.
There are also [husky](https://github.com/typicode/husky) scripts set up to run unit tests
on `pre-commit` and run [Skaffold](https://github.com/GoogleContainerTools/skaffold) on `post-commit`.
## Backend Requirements
This app requires the following services to be running:
- [dashfn](https://github.com/dictybase-playground/kubeless-gofn/tree/master/dashboard) (`REACT_APP_FUNC_SERVER`)
- [graphql-server](https://github.com/dictyBase/graphql-server)
- [graphql-authserver](https://github.com/dictyBase/graphql-authserver)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Eric Hartline
🐛 💻 📖 🎨 🚧 ⚠️
Siddhartha Basu
💻 🚧 🐛 🖋 📖
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Misc badges
[](https://codeclimate.com/github/dictyBase/dictyaccess/code)