Skip to content
No description, website, or topics provided.
TypeScript JavaScript CSS HTML Other
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Delete bug_report.md Oct 9, 2019
.vscode Initial Application Jan 23, 2019
frontend Revert "Support Install of Helm operators" May 5, 2020
k8s RHO-549: Update route for preprod May 15, 2020
server-build Revert "Support Install of Helm operators" May 5, 2020
server Revert "Support Install of Helm operators" May 5, 2020
test-route Add akamai sureroute test Feb 21, 2019
types/shared Revert "Support Install of Helm operators" May 5, 2020
.eslintrc.js
.firebaserc Initial Application Jan 23, 2019
.gitattributes
.gitignore fix link doc olm Sep 6, 2019
.prettierignore Initial Application Jan 23, 2019
.prettierrc Initial Application Jan 23, 2019
.travis.yml RHO-80: Switched to akamai-purge May 17, 2020
Dockerfile Dockerfile: reverting base image latest -> 1-66 Mar 27, 2020
LICENSE Initial Application Jan 23, 2019
README.md Update README.md Nov 21, 2019
babel.config.js Initial Application Jan 23, 2019
build.sh Revert "Operator courier used to migrate operators to nested structure" Jun 3, 2019
deploy.sh Merge pull request #291 from operator-framework/cicd-fix-deployment Apr 30, 2020
invalidate.sh RHO-80: typo May 17, 2020
package.json removed yarn in favor of npm to use single package manager! Oct 7, 2019
run.sh updated and improved readme file Oct 31, 2019
travis.Dockerfile Merge pull request #284 from Edke/travis-ci Apr 30, 2020

README.md

OperatorHub.IO

Welcome to OperatorHub

Operators deliver the automation advantages of cloud services like provisioning, scaling, and backup/restore while being able to run anywhere that Kubernetes can run.

Build

In order to build and run the web application in the same way as it does in production follow the next steps.

Build Frontend
$ pushd frontend
npm install
npm run build
popd
Build Backend
$ pushd backend
npm install
npm run build

Running local server

In server directory

$ npm run server

Other way to do this is to use Docker image in the repo root folder

$ docker build -t operatorhub .
docker run operatorhub

Contributing

Running in Development Mode

This is prefered way when working on front end code. You do not have to care about backend data and front end web server is running in watch mode - it updates when any of the source files is modified and saved.

Running the local UI in dev mode
$ cd frontend
npm install
npm start
http://0.0.0.0:9060/
Contributing Code

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/operatorhub.io.git
# Navigate to the newly cloned directory
cd operatorhub.io
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/operator-framework/operatorhub.io.git
  1. Create a branch:
$ git checkout -b my-branch -t upstream/master
  1. Make your changes and commit to your local branch

Verify there are no lint errors

$ npm run lint

Add and Commit your files

$ git add <files to be committed>
$ git commit
  1. Rebase

Use git rebase (not git merge) to sync your work from time to time. Ensure all commits related to a single issue have been squashed.

$ git fetch upstream
$ git rebase upstream/master
  1. Push
$ git push origin my-branch
  1. Create a Pull Request

Open a pull request with a clear title and description against the dev branch.

The dev branch is used to validate in pre-production mode before moving to the final production servers. Once the changes are validated on the pre-production servers, the maintainers will merge your changes to master and onto the production servers.

License

Licensed under the Apache License 2.0.

You can’t perform that action at this time.