Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

cskujawa/jarvis-ai

Repository files navigation


Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing

About The Project

App Example

⚠️ ⚠️ ⚠️ Disclaimer ⚠️ ⚠️ ⚠️

This documentation and the project as a whole are a work in progress.

J.A.R.V.I.S. is just a really versatile information system.

The front end implements a simple Laravel server utilizing the Laravel Jetstream framework and Vue.

The back end relies on NGINX, MySQL, Prometheus, CAdivsor, Redis, Docker, and Docker-Compose.

(back to top)

Built With

Laravel provides a simple webserver setup and with the easily installable Jetsream package it's a website wrapped up and ready to go. Lravel depends on MySQL for storing data. Front end built with Vue.

Grafana implements graphing nirvana but requires data sources to be connected. This is where Prometheus comes in, it is able to scrape data and format it. CAdvisor is able to collect the data from various sources and store it in a Redis container.

NGINX is what allows all of the containers to commuincate with each other.

  • Laravel
  • VueJS
  • MySQL
  • Grafana
  • Prometheus
  • Redis
  • NGINX
  • CAdvisor

(back to top)

Getting Started

This is a standalone environment that runs on Docker Compose and the monitoring requires Prometheus and Node Exporter to be installed on the host OS. None of the containerized apps require any dependencies to be pre-installed or exist on the host OS. That all being said, if you have Docker Compose you should be able to clone or fork this repo, change to the project directory and boot it up.

Ubuntu Server Setup

Ubuntu Server Guide

WSL Setup

WSL Guide

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published