crater.sh

the opensource docker-compose webapp

Now under the GNU AGPLv3 license!

Tooling

Node.js

• Typescript

  • npm
  • GitHub
  • For strongly typed code and better reliability

• Express

  • npm
  • GitHub
  • Web framework for managing routing and HTTP related operations

• Sequelize

  • npm
  • GitHub
  • ORM to more easily maintain SQL tables and transactions

• Mongoose

  • npm
  • GitHub
  • ORM to more easily maintain NoSQL (MongoDB) tables and transactions

• Minio

  • npm
  • GitHub
  • Client for accessing BLOB data

• Pug

  • npm
  • GitHub
  • Storing HTML as HAML for high reusability and extensibility

• nsfwjs

  • npm
  • GitHub
  • Pornography detection and blocking for user submitted images

• randpix

  • npm
  • GitHub
  • Random pixelart generator for default profile pictures

• redis

  • npm
  • GitHub
  • Client for accessing Redis cache database

• ace

  • npm
  • GitHub
  • CDNJS
  • Frontend syntax highlighting/lightweight IDE for creating and displaying YAML scripts on crater

MySQL

• Docker Hub
• GitHub
• Storing low usage, high reliability transactions

MongoDB

• Docker Hub
• GitHub
• Storing high usage transactions

Minio

• Docker Hub
• GitHub
• Storing BLOBs such as images

Redis

• Docker Hub
• GitHub
• storing key value data in memory such as cookies

Sonarqube

• Docker Hub
• GitHub
• Application to show application flaws and static application health

resources:

• sequelize
• mongoose
• mongoose docs
• markdown

goals

• user auth (in progress)
• interactive landing page
• logo with name
• clone over https
  • auto-gen .env file as well
  • Resources:
    • MIT 2006 git http article
    • MIT git-http-backend
    • rust webserver with git instance on alpine container?
      • HTTP only
      • no remote pushes allowed to repos
      • delete after x timing? store most used longer?
• add dropdown for subpages of subpage youre on
• read sequelize documentation for something similar to mongoose methods
• create unique usernames and passwords for all related applications when in prod
• pornography testing on uploaded images via nsfwjs
• explore testing options?
  • npm i jest --save=dev
  • npm i ts-jest --save-dev
  • npm i @types/jest --save-dev
  • guide
  • docs
• add javascript minifying for frontend code
• headless cms? strapi? I dont want to do that
• make composes/manifest editable

known issues

• Blob storage requires starting and stopping app for bucket and policy to be set
• User account page image is being grabbed from internal IP
• api router needs better 404 etc error handling instead of timing out (i.e. dont stall when hitting /api/v1/user/{not_a_user})