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

Frontend

npm run-script build

Run

npm start

Contributing

Running in Development Mode

Running the local server

$cd server
yarn
yarn server

Running the local UI in dev mode

$cd frontend
yarn
yarn start
http://0.0.0.0:9060/

Running the local UI

$cd frontend
yarn
yarn build
http://0.0.0.0:8080/

Mock Mode

$cd frontend
yarn mock

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

2. Create a branch:

$ git checkout -b my-branch -t upstream/master

3. Make your changes and commit to your local branch

Verify there are no lint errors

$ yarn lint

Add and Commit your files

$ git add <files to be committed>
$ git commit

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

5. Push

$ git push origin my-branch

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