From ed025533cd9ab707b337ab5e658e9cd7e015412b Mon Sep 17 00:00:00 2001 From: Lightling Date: Wed, 6 Nov 2024 17:14:31 -0500 Subject: [PATCH] rename sites to manager --- .gitignore | 2 +- README.md | 4 ++-- docs/arch.md | 4 ++-- docs/content.md | 4 ++-- package-lock.json | 6 +++--- projects/frontend/post-build.js | 6 +++--- projects/{sites => manager}/package.json | 2 +- projects/{sites => manager}/scripts/cms-to-static.js | 0 projects/{sites => manager}/scripts/set-current.js | 0 projects/{sites => manager}/src/log.js | 0 projects/{sites => manager}/src/set-current.js | 2 +- 11 files changed, 15 insertions(+), 15 deletions(-) rename projects/{sites => manager}/package.json (92%) rename projects/{sites => manager}/scripts/cms-to-static.js (100%) rename projects/{sites => manager}/scripts/set-current.js (100%) rename projects/{sites => manager}/src/log.js (100%) rename projects/{sites => manager}/src/set-current.js (93%) diff --git a/.gitignore b/.gitignore index 7036f4d..02ab09a 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,7 @@ dist-ssr *.local .vite-ssg-temp projects/frontend/content -projects/sites/sites +projects/manager/sites # Editor directories and files .vscode/* diff --git a/README.md b/README.md index e4d705d..ae52def 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Make sure you have node installed on your machine. The best way to manage node i ### Managing content -At the minimum, you will need at least one site directory under `/projects/sites/sites/` with a `config.json` file with the required fields set at the root of that directory in order to preview and build your site(s). Run `npm run set-current -w=sites --site=`, where `` matches the name of the folder in `/projects/sites/sites`, in order to set the site you are currently working with. You can have multiple sites in this directory and swap between them with `npm run set-current`. +At the minimum, you will need at least one site directory under `/projects/manager/sites/` with a `config.json` file with the required fields set at the root of that directory in order to preview and build your site(s). Run `npm run set-current -w=manager --site=`, where `` matches the name of the folder in `/projects/manager/sites`, in order to set the site you are currently working with. You can have multiple sites in this directory and swap between them with `npm run set-current`. ### Live Preview @@ -24,4 +24,4 @@ You can run `npm start` in the terminal to spin up a server. Open the address sh ### Building -Running `npm run build` will build out the project. Be sure that you had previously set `npm run set-current -w=sites --site=` before building so that the site builder can build from `config.json`. When the build command is executed, `vite-ssg` will build the frontend into the `/projects/frontend/dist` folder. The build process will ensure that the previously set site is copied into the generated `dist` directory. The `dist` directory contains your static site's files. Note that if you run `npm run set-current` after a build with a different site from that build, you should re-run `npm run build` as well. +Running `npm run build` will build out the project. Be sure that you had previously set `npm run set-current -w=manager --site=` before building so that the site builder can build from `config.json`. When the build command is executed, `vite-ssg` will build the frontend into the `/projects/frontend/dist` folder. The build process will ensure that the previously set site is copied into the generated `dist` directory. The `dist` directory contains your static site's files. Note that if you run `npm run set-current` after a build with a different site from that build, you should re-run `npm run build` as well. diff --git a/docs/arch.md b/docs/arch.md index 118b7e0..6bbe343 100644 --- a/docs/arch.md +++ b/docs/arch.md @@ -5,14 +5,14 @@ This repo is set up to be a monorepo to help manage different projects under the - types: shared types between the remaining libs/projects - projects: end-products which are app-like meant to be built and deployed - frontend: the actual static website generator - - sites: a placeholder for testing and/or managing multiple websites with the same static website generator + - manager: a placeholder for testing and/or managing multiple websites with the same static website generator - cms: a Strapi instance to manage larger sites ## /projects/frontend The frontend is the main project which builds your website from your content config. The frontend is designed to work with dynamic content, i.e. it will not bake your content directly into the resulting HTML so that you can manage content separately. The types of pages that are generated are defined by page templates and are implemented by views (`/projects/frontend/src/views`). -## /projects/sites +## /projects/manager This package helps manage multiple websites in one place. The `./sites` folder is hidden by default for the sake of the main `mackenzii` repo and is meant for maintaining dynamic content outside of source control. If you wish to have some sort of cloud sync or version control in your own setup, there are a few recommended options: - (recommended option) fork `mackenzii` and use symbolic links in the `./sites` directory and include those sites in your cloud sync separate from `mackenzii` diff --git a/docs/content.md b/docs/content.md index 051f70f..ad050dd 100644 --- a/docs/content.md +++ b/docs/content.md @@ -1,6 +1,6 @@ # Site Content -You will need to create a site folder in `/projects/sites/sites/` (ignored by `git`), create a `config.json` file to define how the site generates pages, and have some sort of content in order for the site to generate. Before previewing the site, run `npm run set-current -w=sites --site=` so that the site is linked to the frontend. +You will need to create a site folder in `/projects/manager/sites/` (ignored by `git`), create a `config.json` file to define how the site generates pages, and have some sort of content in order for the site to generate. Before previewing the site, run `npm run set-current -w=manager --site=` so that the site is linked to the frontend. ## `config.json` @@ -123,4 +123,4 @@ All callbacks are optional. `onPageClosed` is called when the user is leaving th ## Other Site Content -You are free to structure your site's content however you want, so long as `config.json` is directly in the root of the main site folder, and so long as it is understood that all files in this folder are assumed to be located at `/content/**` on the web-host. For example, if you have a site in the `/projects/sites/sites` folder named `my.example.org`, this `my.example.org` becomes `https://my.example.org/content` when the site is built and pushed to the host, assuming you are using the default setup used by the development/build scripts described in the ReadMe. `/projects/sites/sites/my.example.org/stylesheets` becomes `https://my.example.org/content/stylesheets`, `/projects/sites/sites/my.example.org/galleries/my-gallery.json` becomes `https://my.example.org/content/galleries/my-gallery.json`, and so on. +You are free to structure your site's content however you want, so long as `config.json` is directly in the root of the main site folder, and so long as it is understood that all files in this folder are assumed to be located at `/content/**` on the web-host. For example, if you have a site in the `/projects/manager/sites` folder named `my.example.org`, this `my.example.org` becomes `https://my.example.org/content` when the site is built and pushed to the host, assuming you are using the default setup used by the development/build scripts described in the ReadMe. `/projects/manager/sites/my.example.org/stylesheets` becomes `https://my.example.org/content/stylesheets`, `/projects/manager/sites/my.example.org/galleries/my-gallery.json` becomes `https://my.example.org/content/galleries/my-gallery.json`, and so on. diff --git a/package-lock.json b/package-lock.json index 9e73fc9..f36d52f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16950,7 +16950,7 @@ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==" }, "node_modules/sites": { - "resolved": "projects/sites", + "resolved": "projects/manager", "link": true }, "node_modules/slash": { @@ -19712,14 +19712,14 @@ "vue-tsc": "2.0.19" } }, - "projects/sites": { + "projects/manager": { "version": "0.0.0", "devDependencies": { "chalk": "5.3.0", "symlink-dir": "6.0.0" } }, - "projects/sites/node_modules/chalk": { + "projects/manager/node_modules/chalk": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", diff --git a/projects/frontend/post-build.js b/projects/frontend/post-build.js index 96731e8..637a3cf 100644 --- a/projects/frontend/post-build.js +++ b/projects/frontend/post-build.js @@ -1,10 +1,10 @@ import { existsSync } from 'fs'; import { readFile } from 'fs/promises'; -import { setCurrent } from '../sites/src/set-current.js' +import { setCurrent } from '../manager/src/set-current.js' (async () => { - if (existsSync('../sites/sites/current.txt')) { - const site = await readFile('../sites/sites/current.txt', { encoding: 'utf-8' }); + if (existsSync('../manager/sites/current.txt')) { + const site = await readFile('../manager/sites/current.txt', { encoding: 'utf-8' }); setCurrent(site); } })(); diff --git a/projects/sites/package.json b/projects/manager/package.json similarity index 92% rename from projects/sites/package.json rename to projects/manager/package.json index 49238ae..7f74b54 100644 --- a/projects/sites/package.json +++ b/projects/manager/package.json @@ -1,5 +1,5 @@ { - "name": "sites", + "name": "manager", "private": true, "version": "0.0.0", "type": "module", diff --git a/projects/sites/scripts/cms-to-static.js b/projects/manager/scripts/cms-to-static.js similarity index 100% rename from projects/sites/scripts/cms-to-static.js rename to projects/manager/scripts/cms-to-static.js diff --git a/projects/sites/scripts/set-current.js b/projects/manager/scripts/set-current.js similarity index 100% rename from projects/sites/scripts/set-current.js rename to projects/manager/scripts/set-current.js diff --git a/projects/sites/src/log.js b/projects/manager/src/log.js similarity index 100% rename from projects/sites/src/log.js rename to projects/manager/src/log.js diff --git a/projects/sites/src/set-current.js b/projects/manager/src/set-current.js similarity index 93% rename from projects/sites/src/set-current.js rename to projects/manager/src/set-current.js index c4e240a..3d530e5 100644 --- a/projects/sites/src/set-current.js +++ b/projects/manager/src/set-current.js @@ -3,7 +3,7 @@ import { existsSync } from 'fs'; import { mkdir, unlink, writeFile } from 'fs/promises'; export const setCurrent = async (site, ctx) => { - const managerPath = ctx?.managerPath || '../sites'; + const managerPath = ctx?.managerPath || '../manager'; const frontendPath = ctx?.frontendPath || '../frontend'; if (!!site) { await symlinkDir(`${managerPath}/sites/${site}`, `${frontendPath}/content`);