cfaa5550d4
- Updated the README and various documentation files to reflect the new flat layout of the `gregFramework`, emphasizing the direct placement of repositories like `gregMod.<Name>/` and `gregExt.<Name>/` under `gregFramework/`. - Added details about the `gregModmanager/` and `gregDataCenterExporter/` directories, clarifying their roles and contents. - Improved descriptions and links throughout the documentation to ensure consistency and accuracy, enhancing user navigation and understanding of the project structure. - Adjusted language in several sections to better communicate the purpose and organization of the repositories. This commit improves the overall clarity and usability of the documentation.
2.5 KiB
gregWiki
Docusaurus site for gregFramework / Data Center modding: configuration (docusaurus.config.js, sidebars.js), React under src/, content under docs/. Published route base path: /wiki.
Part of gregFramework
This directory is part of the gregFramework workspace. Clone sibling repositories side by side so each project lives at gregFramework/<RepoName>/. See the workspace README for the full layout and migration notes.
Remote: mleem97/gregWiki — on-disk path: gregFramework/gregWiki/.
Local development
npm install
npm run start
Production build:
npm run build
Optional: mirror the legacy GitHub Wiki — see docs/getting-started/documentation-layout.md and scripts wiki:sync / wiki:normalize-i18n.
Deployment (Coolify / CI)
- Default branch:
main— use this for new work and PRs. master: may still exist for older deployments; in Coolify, set the branch tomainwhen possible.
Coolify (Dockerfile) — missing /app/package.json
The image expects package.json at the image root /app. That only works if the Docker build context is this repository (gregWiki), not a parent monorepo folder without adjustments.
| Setting | Value |
|---|---|
| Dockerfile | Dockerfile at the gregWiki root |
| Base directory | . when only gregWiki is cloned. If gregWiki sits next to gregCore in the same clone, often set gregWiki as the subdirectory. |
| Volumes | Do not use an empty host mount over /app that hides package.json. |
Symptom: docker-entrypoint: ERROR: /app/package.json not found → wrong context or volume.
Docker (local)
Build context = this repository (folder that contains package.json):
cd path/to/gregWiki
docker compose up --build
If gregWiki lives inside gregFramework, from the workspace root:
cd path/to/gregFramework
docker compose -f docker-compose.gregwiki.yml up --build
(docker-compose.gregwiki.yml sets build.context: ./gregWiki.)
See also
- gregFramework README — flat layout
gregFramework/{RepoName}/ - Source code and builds: gregCore, gregMod.* , gregExt.* as separate repositories (not only this documentation)