gridfinitycreator

Gridfinity STL file generator web application

https://github.com/jeroen94704/gridfinitycreator

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Gridfinity STL file generator web application

Basic Info
  • Host: GitHub
  • Owner: jeroen94704
  • License: other
  • Language: Python
  • Default Branch: main
  • Size: 1.55 MB
Statistics
  • Stars: 25
  • Watchers: 3
  • Forks: 4
  • Open Issues: 2
  • Releases: 10
Created about 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Funding License Citation

README.md

All Contributors Server status

Gridfinity Creator

This application generates STL or STEP files of configurable Gridfinity compatible components. For example, for the standard divider bin you can specify width, length, height, number of compartments (in both directions) and whether or not you want a stacking lip, magnet holes, screw holes, curved scoop surface and/or one or more label tabs. Here are some of the possible bins you can create in this way: gridfinity-options The total number of possible combinations with those options is beyond one million, which is why the 3D models are dynamically created and not pre-calculated.

Available components

There are currently a few components available, listed below. Other components are in the works.

  • Baseplate: Basic baseplate without screws, magnets or weighting.
  • Divider bin: Standard divider bin very similar to Zack's original design.
  • Light bin: A light version of the normal Gridfinity bin that saves plastic and offers more room. This means there is no room for magnets and/or screws
  • Solid bin: A completely filled solid Gridfinity bin which can be used as a starting point for custom bins
  • Holey bin: A solid bin with a grid of holes of user-defined shape, size and depth. Includes option for a keepout-area around each hole

Online generator

If you don't know how to run your own server (or simply don't want to), there should be an instance of the generator running at https://gridfinity.bouwens.co. No uptime guarantees, but it has been running since early 2023 and seems stable enough, even with the occasional spike in load.

Installation and deployment

The generator runs as a web-application in a docker container. To run your own instance, perform the following steps from the command line:

  • Download and unzip the code or clone the repository: git clone https://github.com/jeroen94704/gridfinitycreator
  • cd into the source directory
  • Build the Docker Image: ./build.sh (may need to prefix this with 'sudo')
  • Start the server: ./deploy.sh (may need to prefix this with 'sudo')

Now you can access the application by opening a browser and navigating to :5000, e.g.

http://192.168.1.100:5000/

Debug mode

The deploy script results in the server running in production mode using the Waitress WSGI server. This is good for performance, but if you want to debug the code, start the server using the "./debug.sh" script instead of "./deploy.sh". This will make the server start itself using the built-in Flask server, which has convenient debugging features.

Reverse proxy

Because I use Traefik myself I included the Traefik labels I use in the docker-compose file. If you want to use Traefik, uncomment them and comment out the "ports" section. You will also need to fill in your domain in the .env.container file.

I have no experience with other reverse proxy methods (Apache, nginx, Helm, etc), so if anyone creates instructions for setting up GridfinityCreator with any of those I'd happily accept the pull-request.

Contributors

Kirk Kirkconnell
Kirk Kirkconnell

🤔
wug-ge
wug-ge

🐛
Chase Bolt
Chase Bolt

🐛

Donate

If you find this project useful a small donation is much appreciated (but by no means required or expected): https://ko-fi.com/jeroen94704

License

GridfinityCreator © 2023 by Jeroen Bouwens is licensed under CC BY-NC-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/

Owner

  • Name: Jeroen Bouwens
  • Login: jeroen94704
  • Kind: user
  • Location: Eindhoven - the Netherlands

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: GridfinityCreator
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Jeroen
    family-names: Bouwens
repository-code: 'https://github.com/jeroen94704/gridfinitycreator/'
url: 'https://gridfinity.bouwens.co/'
abstract: >-
  GridfinityCreator dynamically generates custom STL or STEP
  files for several types of Gridfinity components. 
keywords:
  - gridfinity
  - cadquery
  - stl
  - step
  - 3dprinting
license: CC-BY-NC-SA-4.0
commit: 471f3bbbabadb084ef1bf07ec81898326b21c8a1
version: 0.4.4
date-released: '2024-12-03'

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 4
  • Watch event: 20
  • Delete event: 1
  • Issue comment event: 6
  • Push event: 21
  • Pull request event: 5
  • Fork event: 4
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 4
  • Watch event: 20
  • Delete event: 1
  • Issue comment event: 6
  • Push event: 21
  • Pull request event: 5
  • Fork event: 4

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 1
  • Total pull requests: 1
  • Average time to close issues: 8 days
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: 8 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jeroen94704 (9)
  • NoSQLKnowHow (4)
  • wug-ge (1)
  • chasebolt (1)
  • chrisn-au (1)
Pull Request Authors
  • jeroen94704 (12)
  • allcontributors[bot] (3)
  • dseifert (1)
Top Labels
Issue Labels
Pull Request Labels