orobardet/3dptools repository overview

⁠3DPTools

Web-based 3DPrinting tools. For now it allow you to manage your 3D printing filament collection.

The following features may be added in the future: resin collection management, 3D printers collection management, loading, visualisation and analyse of gcode file...

⁠Requirements

⁠Run

• NodeJS⁠ (12.x) with
• ImageMagick
• MongoDB⁠ (>=3.6, with 3.6 Feature compatibility enabled⁠).
  Tested and OK with MongoDB 4.0
• Redis⁠
• Any OS where the previous requirements runs. Has been proven to work on Linux (Ubuntu and Debian tested) and Windows (Windows 10 tested).
• Of course MongoDB and Redis does not needs to run on the same host as the Node app.
• Docker (only if run as Docker containers)

⁠Dev/build

• Bower (sudo npm install -g bower)
• build-essential (as know on Debian-like OS, or any other equivalent on your OS ; needed to build some dependencies)
• SASS (install dart-sass⁠ or with npm: sudo npm install -g sass)
• Any OS where the previous requirements runs. Has been proven to work for development on Linux (Ubuntu and Debian tested) and Windows (Windows 10 tested).
• Docker (only to build docker image or run the development environment as Docker containers)

⁠Setup and run

⁠Manual

First, you need to get the code:

git clone [email protected]:orobardet/3DPTools.git
cd 3DPTools/src

Then prepare it:

yarn install --production
bower install --production
scss -f public/stylesheets/style.scss > public/stylesheets/style.css

And finally run it:

NODE_ENV=production npm start

⁠Using Docker

A docker-compose.yml⁠ file is provided to run this image using Docker. It start a Redis and a MongoDB (both in very basic and minimalist mode).

For Linux, MacOS, Window 10 1803+ or any OS having curl:

curl -o "docker-compose.yml" "https://gitlab.com/orobardet/3DPTools/raw/master/docker-compose.yml"

So you can start a instance with just :

docker-compose up -d
# (You can view logs with: docker-compose logs -f)

When the main container starts, it first wait for redis and mongo to be up and running. If these required services are not available within the allowed time (10 minutes by default), the container fails.

Once the application has successfully start, you can access to 3DPTools using the url http://localhost:3000/⁠. If no valid data is already found, the 3DPTools will start in setup mode. Just follow the instructions.

By default, the docker-compose environment will create a docker-volumes folder that will hold data for persistence: you can stop, kill and restart the Docker environment and still retreive all your data, as long as the docker-volumes is kept.

You can change some parameters of the docker-compose environment by creating a docker-compose.override.yml file. Common changes can be :

• the access port: override the ports mapping of the 3dptools service
• the mapped volumes for data: override the volumes of the mongo service
• start 3dptools in development mode: add the environment variable NODE_ENV=dev in the 3dptools service
• parameters for waiting for redis and mongo in the 3dptools service using the following environment variables:
  • WAIT_REDIS_MAX_TRIES, 120 by default
  • WAIT_REDIS_TRY_INTERVAL, 5s by default
  • WAIT_MONGO_MAX_TRIES, 120 by default
  • WAIT_MONGO_TRY_INTERVAL, 5s by default

Some docker-compose.override.yml sample are provided in the files docker-compose.override.dist.*.yml

⁠Configuration

This application can be configured by giving it some parameters on startup. Most of the settings have default values.

You can find configuration instructions and all available configuration settings in the documentation⁠.