README.md

⚡ Kuberneat ⚡

Supported OS

---

Features

(back to top)

Getting Started With Kuberneat

Running Kuberneat

1. Fork and clone the dev branch onto your local branch.

   https://github.com/oslabs-beta/Kuberneat.git

2. Install all the dependencies

      npm install 

3. Create process.env file at the root directory

   root
      ├─ process.env
      ├─ electron
      └─ src

4. Connect to NoSQL database in .env

   mongoURI = "Your NoSQL URI string"

5. Ensure your cluster is running and then you can start the desktop application with:

   npm run electron

(back to top)

Made with

For Frontend Development

For Backend Development

For Monitoring and Data Visualizations

(back to top)

Contributions

For more information regarding how to contribute, please refer to the CONTRIBUTING.md guidelines from this repo.

1. Fork and clone the dev branch onto your local branch.

   https://github.com/oslabs-beta/Kuberneat.git

2. Create a new a feature branch

   [your-name]/AWESOME-FEATURES

3. Install all the dependencies

      npm install 

4. Create process.env file at the root directory

   root
      ├─ process.env
      ├─ electron
      └─ src

5. Connect to NoSQL database in .env

   mongoURI = "Your NoSQL URI string"

6. Please ensure you are following eslint conventions.

7. Please ensure to create tests for your feature and that it passes your test suite.

8. Please be detailed in your pull request.

   

(back to top)

Founders

• Harvey Li LinkedIn | GitHub
• Amy (Aimée) Nguyen LinkedIn | GitHub
• John Wroge LinkedIn | GitHub
• Ed Cho LinkedIn | GitHub

(back to top)