{"id":26267694,"url":"https://github.com/oslabs-beta/neptune","last_synced_at":"2025-07-25T12:34:48.736Z","repository":{"id":39607767,"uuid":"507069050","full_name":"oslabs-beta/Neptune","owner":"oslabs-beta","description":"A light-weight, simple, and straightforward learning tool for your Kubernetes cluster","archived":false,"fork":false,"pushed_at":"2022-08-11T03:24:01.000Z","size":33316,"stargazers_count":109,"open_issues_count":0,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-30T19:11:20.948Z","etag":null,"topics":["expressjs","kubernetes","nodejs","prometheus","react"],"latest_commit_sha":null,"homepage":"https://exploreneptune.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oslabs-beta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-24T16:02:31.000Z","updated_at":"2024-09-24T03:41:23.000Z","dependencies_parsed_at":"2022-07-13T09:10:42.733Z","dependency_job_id":null,"html_url":"https://github.com/oslabs-beta/Neptune","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oslabs-beta/Neptune","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FNeptune","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FNeptune/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FNeptune/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FNeptune/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oslabs-beta","download_url":"https://codeload.github.com/oslabs-beta/Neptune/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FNeptune/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267007531,"owners_count":24020259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["expressjs","kubernetes","nodejs","prometheus","react"],"created_at":"2025-03-14T04:17:51.958Z","updated_at":"2025-07-25T12:34:48.675Z","avatar_url":"https://github.com/oslabs-beta.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introducing Neptune\n\u003cp\u003e\n\u003cimg src=\"https://github.com/MirandaJaramillo/githubImages/blob/main/images/centered_neptune.png\" title=\"neptune\" alt=\"neptune\" /\u003e\u0026nbsp;\n\u003cp\u003e \n\u003cp align=\"center\"\u003e\n   \u003cstrong\u003eLight-weight, simple, and straightforward learning tool for your Kubernetes cluster\u003c/strong\u003e\n\n   Neptune is an approachable learning tool, light-weight in nature with a few monitoring features. PromQL has a steep learning curve and not everyone needs to learn how to use these queries. We have pre-selected a few relevant queries that display basic data about a simple Kubernetes cluster. This is to reduce the amount of noise when engaging with Prometheus. Neptune is meant to be an easy, visual way to understand a K8s cluster.\n\u003ca href=\"https://exploreneptune.io\"\u003eLearn more about Neptune here.\u003c/a\u003e\n\n## Focus on what matters, with built in alerts and health monitoring.\n\nRender the metrics of your nodes, pods, and namespaces all in one easy to visualize UI.\n\n![neptune1](https://user-images.githubusercontent.com/96557317/180123940-4a9f50bc-a63e-45fd-904a-d3b346686138.gif)\n\n## Metrics that matter\n\nRather than being overloaded with countless metrics, focus on the ones that matter. We highlighted prominent data points related to CPU, Memory, and Network Usage\n\n![neptune2](https://user-images.githubusercontent.com/96557317/180123960-78356a62-17bd-495b-bac9-179a34449796.gif)\n\n## Alerts, Event Logs, and Cluster Health\n\nSort through your firing alerts by severity to stay on top of your alerts\nQuick and simplified overview of your cluster health and performance\n\n![neptune3](https://user-images.githubusercontent.com/96557317/180123967-93d53f8c-aed1-4e67-8d96-963554b87f63.gif)\n\n# Getting Started\n\nPrerequisites\nThere are some prerequisites before you start with Neptune, so make sure you have Docker and Minikube setup. We highly recommend that you follow the order below.\n\nInstall Docker Desktop - the fastest way to containerize applications\nInstall minikube - minikube quickly sets up a local Kubernetes cluster on macOS, Linux, and Windows\nInstall Helm - package manager for Kubernetes\nDeploy Prometheus - software application that scrapes clusters and returns metrics\n\nNote: Make sure your minikube cluster is actively running!\n\n1. Clone this repo and then change directory into the root folder. Then run the command below:\n   git clone git@github.com:oslabs-beta/Neptune.git\n\n2. Install dependencies\n   Run these commands from within the root directory:\n\nnpm install\n\nnpm run build\n\nnpm run start\n\n3. Port-forward Prometheus to 9090\n   To port-forward Prometheus, run the following command. Remember that your minikube cluster needs to be actively running!\n\nkubectl port-forward prometheus-prometheus-kube-prometheus-prometheus-0 --namespace=default 9090:9090\n\n4. Explore Neptune!\n   Go to http://localhost:3000/ and start exploring your Kubernetes cluster!\n\n## 🛠 \u0026nbsp; Built With :\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/kubernetes/kubernetes-plain-wordmark.svg\" title=\"Kubernetes\" alt=\"Kubernetes\" width=\"50\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/react/react-original-wordmark.svg\" title=\"React\" alt=\"React\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/prometheus/prometheus-original-wordmark.svg\" title=\"Prometheus\" alt=\"Prometheus\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/materialui/materialui-original.svg\" title=\"Material UI\" alt=\"Material UI\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/css3/css3-plain-wordmark.svg\"  title=\"CSS3\" alt=\"CSS\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/html5/html5-original.svg\" title=\"HTML5\" alt=\"HTML\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/javascript/javascript-original.svg\" title=\"JavaScript\" alt=\"JavaScript\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/webpack/webpack-original-wordmark.svg\" title=\"Webpack\"  alt=\"Webpack\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/nodejs/nodejs-original-wordmark.svg\" title=\"NodeJS\" alt=\"NodeJS\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://www.vectorlogo.zone/logos/getpostman/getpostman-icon.svg\" title=\"Postman\"  alt=\"Postman\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/git/git-original-wordmark.svg\" title=\"Git\" **alt=\"Git\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\u003cimg src=\"https://github.com/devicons/devicon/blob/master/icons/docker/docker-original-wordmark.svg\" title=\"Docker\" **alt=\"Git\" width=\"40\" height=\"40\"/\u003e\u0026nbsp;\n\n\u003c/p\u003e\n\n\n\n\n## The Core Team\n\u003ctable align=\"center\"\u003e\u003ctbody\u003e\u003ctr\u003e\n  \u003ctd align=\"center\" width=\"150\"\u003e\n    \u003cimg src=\"https://github.com/MirandaJaramillo/githubImages/blob/main/images/SwanHtet.png\" style=\"height: 5rem; width: 5rem;\" /\u003e\n    \u003cbr/\u003e\n    \u003cstrong\u003eSwan Htet\u003c/strong\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://github.com/swanhtethtetswan\"\u003eGitHub\u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://www.linkedin.com/in/swan-htet-htet-swan/\"\u003eLinkedIn\u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd align=\"center\" width=\"150\"\u003e\n    \u003cimg src=\"https://github.com/MirandaJaramillo/githubImages/blob/main/images/Miranda-Headshot2022%20circle.png\" style=\"height: 5rem; width: 5rem;\" /\u003e\n    \u003cbr/\u003e\n    \u003cstrong\u003eMiranda Jaramillo\u003c/strong\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://github.com/mirandajaramillo\"\u003eGitHub\u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://www.linkedin.com/in/miranda-jaramillo/\"\u003eLinkedIn\u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd align=\"center\" width=\"150\"\u003e\n    \u003cimg src=\"https://github.com/MirandaJaramillo/githubImages/blob/main/images/LawrenceYeh.png\" style=\"height: 5rem; width: 5rem;\" /\u003e\n    \u003cbr/\u003e\n    \u003cstrong\u003eLawrence Yeh\u003c/strong\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://github.com/lawyeh\"\u003eGitHub\u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://www.linkedin.com/in/lawyeh/\"\u003eLinkedIn\u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd align=\"center\" width=\"150\"\u003e\n    \u003cimg src=\"https://github.com/MirandaJaramillo/githubImages/blob/main/images/JinYoo.png\" style=\"height: 5rem; width: 5rem;\" /\u003e\n    \u003cbr/\u003e\n    \u003cstrong\u003eJin Yoo\u003c/strong\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://github.com/iyoojin\"\u003eGitHub\u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ca href=\"https://www.linkedin.com/in/iyoojin/\"\u003eLinkedIn\u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2Fneptune","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foslabs-beta%2Fneptune","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2Fneptune/lists"}