refactored the repo to make 'npm create harmonia' possible

Author: rocambille

.husky/pre-commit

@@ -1,23 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-fileList=$(git diff --staged --name-only :^package-lock.json :^README.md :^client :^server)
-
-echo '----- Checking Root...'
-
-if [ ! -z "$fileList" ]
-then
-  echo "error: Unauthorized modifications\n"
-
-  echo "$fileList\n"
-
-  echo "use 'git restore --staged ...' to fix the problem"
-  echo "(and ask your instructor why you should not change these files)\n"
-
-  exit 1
-fi
-
-echo '----- Done!'
-
-npx validate-branch-name
 npm run lint

.tours/01-get-started.tour

@@ -190,7 +190,7 @@ tables.foo.callSomeCrudMethod();
 
 ### Added
 
-- Git commands for Windows users, to fix issues with different newline formats (see [README.md](README.md#windows-users)).
+- Git commands for Windows users, to fix issues with different newline formats (see [README.md](template/README.md#windows-users)).
 
 ### Changed
 

.tours/02-frontend.tour

@@ -4,9 +4,9 @@
 
 - **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead send an email to [email protected].
 
-- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/wildcodeschool/our-resql/issues).
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/wildcodeschool/create-harmonia/issues).
 
-- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/wildcodeschool/our-resql/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/wildcodeschool/create-harmonia/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
 
 #### **Did you write a patch that fixes a bug?**
 
@@ -20,9 +20,9 @@ Changes that are cosmetic in nature and do not add anything substantial to the s
 
 #### **Do you intend to add a new feature or change an existing one?**
 
-- **Ensure the change was not already proposed** by searching on GitHub under [Issues](https://github.com/wildcodeschool/our-resql/issues).
+- **Ensure the change was not already proposed** by searching on GitHub under [Issues](https://github.com/wildcodeschool/create-harmonia/issues).
 
-- If you're unable to find an appropriate open issue, [open a new one](https://github.com/wildcodeschool/our-resql/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+- If you're unable to find an appropriate open issue, [open a new one](https://github.com/wildcodeschool/create-harmonia/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
 
 - Do not start writing code until you have collected positive feedback on the issue 🙂
 

.tours/03-backend.tour

@@ -1,6 +1,6 @@
-## Concept
+# Harmonia
 
-This framework is meant to serve as a foundation for every project following the React-Express-MySQL stack, as learned in Wild Code School.
+Harmonia is a framework meant to serve as a foundation for every project following the React-Express-MySQL stack, as learned in Wild Code School.
 It's pre-configured with a set of tools which'll help students produce industry-quality and easier-to-maintain code, while staying a pedagogical tool.
 
 ## Setup & Use

CHANGELOG.md

@@ -0,0 +1,147 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+
+import * as p from "@clack/prompts";
+import { bold, cyan, grey } from "kleur/colors";
+import Mustache from "mustache";
+import { execSync } from "node:child_process";
+
+const { version } = JSON.parse(
+  fs.readFileSync(new URL("../package.json", import.meta.url), "utf-8")
+);
+
+console.log(`
+${grey(`create-harmonia version ${version}`)}
+`);
+
+let [org, name] = process.argv[2].split("/") ?? [];
+
+if (name == null) {
+  name = org;
+  org = null;
+}
+
+if (org == null) {
+  org = await p.text({
+    message: "What is your organization name?",
+    placeholder: "  (hit Enter to use empty string)",
+  });
+
+  if (p.isCancel(org)) process.exit(1);
+
+  if (org == null) {
+    org = /** @type {string} */ ("");
+  }
+}
+
+p.intro("Welcome to Harmonia!");
+
+if (name === ".") {
+  const dir = await p.text({
+    message: "Where should we create your project?",
+    placeholder: "  (hit Enter to use current directory)",
+  });
+
+  if (p.isCancel(dir)) process.exit(1);
+
+  if (dir) {
+    name = /** @type {string} */ (dir);
+  }
+}
+
+if (fs.existsSync(name)) {
+  if (fs.readdirSync(name).length > 0) {
+    const force = await p.confirm({
+      message: "Directory not empty. Continue?",
+      initialValue: false,
+    });
+
+    // bail if `force` is `false` or the user cancelled with Ctrl-C
+    if (force !== true) {
+      process.exit(1);
+    }
+  }
+}
+
+const destDir = path.resolve(process.cwd(), name);
+
+const sCp = p.spinner();
+
+sCp.start("Copying files");
+
+fs.cpSync(new URL("../template", import.meta.url), destDir, {
+  recursive: true,
+});
+
+sCp.stop("Copied files");
+
+const sMustache = p.spinner();
+
+sMustache.start("Filling templates");
+
+const data = { name, org, year: new Date().getFullYear() };
+
+fs.writeFileSync(
+  `${destDir}/package.json`,
+  Mustache.render(
+    fs.readFileSync(`${destDir}/package.template.json`, "utf8"),
+    data
+  )
+);
+fs.rmSync(`${destDir}/package.template.json`);
+
+fs.writeFileSync(
+  `${destDir}/package-lock.json`,
+  Mustache.render(
+    fs.readFileSync(`${destDir}/package-lock.template.json`, "utf8"),
+    data
+  )
+);
+fs.rmSync(`${destDir}/package-lock.template.json`);
+
+fs.writeFileSync(
+  `${destDir}/LICENSE.md`,
+  Mustache.render(
+    fs.readFileSync(`${destDir}/LICENSE.template.md`, "utf8"),
+    data
+  )
+);
+fs.rmSync(`${destDir}/LICENSE.template.md`);
+
+sMustache.stop("Filled templates");
+
+const sGit = p.spinner();
+
+sGit.start("Starting git");
+
+execSync(
+  `cd ${destDir} && git init && git add -A && git commit -m "Initial commit" -n`
+);
+
+sGit.stop("Started git");
+
+p.outro("Your project is ready!");
+
+console.log("\nNext steps:");
+let i = 1;
+
+const relative = path.relative(process.cwd(), name);
+
+if (relative !== "") {
+  console.log(`  ${i++}: ${bold(cyan(`cd ${relative}`))}`);
+}
+
+console.log(`  ${i++}: ${bold(cyan(`npm install`))}`);
+console.log(
+  `  ${i++}: ${bold(cyan(`cp client/.env.sample client/.env && nano client/.env`))}`
+);
+console.log(
+  `  ${i++}: ${bold(cyan(`cp server/.env.sample server/.env && nano server/.env`))}`
+);
+console.log(`  ${i++}: ${bold(cyan(`npm run dev`))}`);
+
+console.log(`\nTo stop the run, hit ${bold(cyan("Ctrl-C"))}`);
+console.log(
+  `\nStuck? Visit us at ${cyan("https://documentation-harmonia.vercel.app/")}`
+);