This repository contains the source code for tools.ptrmc.net, a collection of tools for developers.
It combines a few projects into one docker image, which is then deployed to tools.ptrmc.net.
Details about the complicated structure of this repo :D
GitRSS, openapi-merger and package-json-analyzer are added as submodules. Patches for each submodule are present at /patches/<submodule name>
The directory is a website thats is bridge between the 3 tools. It Includes the terms and FAQs of each tool.
This directory is an html site that serves the API docs for the site.
The nginx configuration and the start script for the docker image are located here
There is a build tool (./build) that is used to:
- apply patches
- create/generate patches
- update submodules
- hard reset submodules
- install dependencies on all projects
- build the docker image
- run a test docker image
For more info run ./build help to see detailed info about each command
Everything is held together in a docker image. Each project frontend is build and served using nginx and the APIs are build and ran using NodeJS.
Just use the example docker compose files thats provided:
git clone https://github.com/PetarMc1/tools.ptrmc.net
docker compose up -dI do not recommend to try to develop on this project. But if you wish to heres a guide:
- Apply patches to all submodules:
./build patch- Install dependencies on all projects:
./build install- Do the changes you want. If they are on nay of the submodules make sure you have committed the changes to the submodule and then create new patch files:
./build create-patch- Build the final docker image to check for errors:
./build build <tag of the image>OR if you just want to test if it compiles you can run:
./build run <optional tag>This runs a test container named tools-test, listening on port 80.
- Commit the patches to your fork and submit a Pull Request.
GitRSS, openapi-merger and package-json-analyzer are licensed under the Apache 2.0 License.