Code Monkey home page Code Monkey logo

makeea / octofarm Goto Github PK

View Code? Open in Web Editor NEW

This project forked from octofarm/octofarm

0.0 0.0 0.0 96.37 MB

OctoFarm is an web server and client combination for unifying multiple instances of Octoprint. You can manage and monitor as many instances as you want from a single interface giving you full control over your 3D printer farm.

Home Page: https://octofarm.net

License: GNU Affero General Public License v3.0

Shell 0.04% JavaScript 79.94% CSS 0.50% Dockerfile 0.10% EJS 19.41%

octofarm's Introduction

Docker Pulls GitHub stars GitHub forks GitHub license GitHub Workflow Status GitHub issues Maintenance Download Dockerhub

OctoFarm Latest Release

Logo

OctoFarm is a single pane of glass that combines multiple OctoPrint instances into a single interface. It utilises the OctoPrint API and websocket systems to monitor and allow management of your 3d printer farm.

A free and open source makers farm management software
Explore the documentation

· Report a bug · Request a feature or ask a question

About OctoFarm

OctoFarm Dashboard

OctoFarm was built to fill a need that anyone with multiple 3D printers with Octoprint will have run into. How do I manage multiple printers from one place? That's where OctoFarm steps in, add your OctoPrint instances to the system and it will scan and keep you up to date on the status of your printers.

Built by a maker, for makers to get more out of their OctoPrint run farms.

  • Manager your OctoPrint instances right down to triggering Updates and Plugin installs.
  • Keep a track of all the live data on your farm with a selection of views.
  • Manage your OctoPrint file system.
  • Get an overview of your farm with the customisable dashboard.
  • Manage and track filament on your farm.
  • Track history and logs for all of your instances.
  • Supports a wide variety of OctoPrint plugins to augment the OctoFarm system with more information.

Need help?

Feel free to join any of the OctoFarm communities or follow OctoFarms progress on it's blog.

Getting Started

Before installing it is best to read the getting started documents here: Getting Started

Installation Production

Check out the OctoFarm documentation website for installation instructions on various platforms Getting Started

Installation Development

  1. Clone the OctoFarm
git clone https://github.com/NotExpectedYet/OctoFarm.git
  1. Install the mono-repo eslint dependencies (eslint, prettier and nodemon)
npm install
  1. Install server and client dependencies
npm run setup-dev
  1. Create an .env file in the OctoFarm folder's root directory. e.g. OctoFarm/.env. Paste in the contents below.
NODE_ENV=development
MONGO=mongodb://127.0.0.1:27017/octofarm
OCTOFARM_PORT=4000
  1. Build the latest client
npm run build-client
  1. (Optional): Watch for client changes, requires a secondary console.
npm run dev-client
  1. Start the server
npm run server-dev
  • The developer version uses nodemon for live server reloading on changes. It will output all the logs to the console.

License

This work is licensed under the GNU Affero General Public License v3.

Contact

You can contact me at [email protected]

Acknowledgements

  • My Patreons - You all keep me going and afford me a financial incentive to keep OctoFarm up to date with new features and fixes! Biggest thanks of all.
  • Gina Häußge - Without OctoPrint none of this would be possible. Massive thanks to the work of Gina and everyone who helps out with that.
  • Derek from 3D Printed Debris - Massive big thanks to Derek who has donated a lot of time and money to the project. I don't think I'd have continued at the rate I did without his bug reports and support.
  • JetBrains IDE - Thanks to JebBrains for allowing a free license to use with developing my application. Their IDE is top notch!

octofarm's People

Contributors

notexpectedyet avatar notexpectyet avatar jamesvexica avatar davidzwa avatar mearman avatar torresmvl avatar dependabot[bot] avatar manfredrichthofen avatar eduardooliveira avatar thetinkerdad avatar tonysurma avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.