Skip to content

dictyBase/genomepage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Genomepage

All Contributors

License
GitHub tag GitHub action
codecov Maintainability
Last commit
Funding

This is the Genomepage web application to display genomic 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 here.

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 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 dev as usual.

Backend Requirements

This app requires the following services to be running:

Mock Server

In case the GraphQL server is unavailable or does not have the queries implemented, you can use the mock server by running the command:

yarn start:mock

This command makes use of the NEXT_PUBLIC_MOCK_SERVER environment variable while in development mode (NEXT_PUBLIC_DEPLOY_ENV='development'), which will activate the mock server that will intercept the requests made to the GraphQL server.

To update the data used by the mock server see mocks/handlers.ts, and update the query and mock data accordingly.

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