Merge pull request #157 from WildCodeSchool/dev

Dev

CHANGELOG.md

@@ -7,7 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Open an issue](https://github.com/WildCodeSchool/create-harmonia/issues) if you have any request/feedback :)
+[Open an issue](https://github.com/WildCodeSchool/create-js-monorepo/issues) if you have any request/feedback :)
+
+## [7.0.0] - 2024-07-20
+
+### Changed
+
+- **Breaking change:** Renamed package from `create-harmonia` to `@wildcodeschool/create-js-monorepo`.
+
+- **Breaking change:** Migrated from ESLint and Prettier to [Biome](https://biomejs.dev/).
+
+- **Breaking change:** Migrated client and server to TypeScript.
+
+- **Breaking change:** Refactored server from MVC to module-based architecture.
 
 ## [5.0.9] - 2024-05-06
 

CONTRIBUTING.md

@@ -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/create-harmonia/issues).
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/wildcodeschool/create-js-monorepo/issues).
 
-- 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.
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/wildcodeschool/create-js-monorepo/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/create-harmonia/issues).
+- **Ensure the change was not already proposed** by searching on GitHub under [Issues](https://github.com/wildcodeschool/create-js-monorepo/issues).
 
-- 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.
+- If you're unable to find an appropriate open issue, [open a new one](https://github.com/wildcodeschool/create-js-monorepo/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 🙂
 

README.md

@@ -1,18 +1,18 @@
-# Harmonia
+# JS Monorepo
 
-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.
+This JS monorepo 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
 
 Basic usage:
 
 ```bash
-npm create harmonia@latest my-project
+npm create @wildcodeschool/js-monorepo@latest my-project
 ```
 
 You may prefix your project name with the name of your organization:
 
 ```bash
-npm create harmonia@latest my-org/my-project
+npm create @wildcodeschool/js-monorepo@latest my-org/my-project
 ```

bin/create-harmonia.js → bin/create-js-monorepo.js

@@ -12,12 +12,12 @@ const { version } = JSON.parse(
 );
 
 console.log(`
-${grey(`create-harmonia version ${version}`)}
+${grey(`create-js-monorepo version ${version}`)}
 `);
 
 if (process.argv[2] == null) {
   throw new Error(
-    "Please provide a project name, e.g. npm create harmonia@latest my-project"
+    "Please provide a project name, e.g. npm create @wildcodeschool/js-monorepo@latest my-project"
   );
 }
 
@@ -41,7 +41,7 @@ if (org == null) {
   }
 }
 
-p.intro("Welcome to Harmonia!");
+p.intro("Welcome to your JS Monorepo!");
 
 if (name === ".") {
   const dir = await p.text({
@@ -138,7 +138,12 @@ const sGit = p.spinner();
 sGit.start("Starting git");
 
 execSync(
-  `cd ${destDir} && git init && git add -A && git commit -m "Initial commit" -n`
+  `cd ${destDir} \
+  && git init \
+  && git add -A \
+  && git commit -m "Initial commit" -n \
+  && git switch -c staging \
+  && git switch -c dev`
 );
 
 sGit.stop("Started git");
@@ -154,20 +159,26 @@ if (relative !== "") {
   console.log(`  ${i++}: ${bold(cyan(`cd ${relative}`))}`);
 }
 
+console.log(`  ${i++}: ${bold(cyan(`git remote add origin ...`))}`);
+console.log(`  ${i++}: ${bold(cyan(`git push --all -u`))}`);
 console.log(`  ${i++}: ${bold(cyan(`npm install`))}`);
 console.log(
   `  ${i++}: ${bold(
-    cyan(`cp client/.env.sample client/.env && nano client/.env`)
+    cyan(
+      `copy 'client/.env.sample' as 'client/.env' and check the contents of 'client/.env'`
+    )
   )}`
 );
 console.log(
   `  ${i++}: ${bold(
-    cyan(`cp server/.env.sample server/.env && nano server/.env`)
+    cyan(
+      `copy 'server/.env.sample' as 'server/.env' and check the contents of 'server/.env'`
+    )
   )}`
 );
 console.log(`  ${i++}: ${bold(cyan(`npm run dev`))}`);
 
 console.log(`\nUse ${bold(cyan("Ctrl-C"))} to halt the server.`);
 console.log(
-  `\nStuck? Visit us at ${cyan("https://documentation-harmonia.vercel.app/")}`
+  `\nStuck? Visit us at ${cyan("https://wildcodeschool-js-monorepo.vercel.app/")}`
 );

package.json

@@ -1,22 +1,21 @@
 {
-  "name": "create-harmonia",
-  "version": "5.0.10",
+  "name": "@wildcodeschool/create-js-monorepo",
+  "version": "7.0.0",
   "type": "module",
   "description": "Our pedagogical framework for the React-Express-MySQL cursus in Wild Code School",
-  "homepage": "https://github.com/wildcodeschool/create-harmonia#readme",
+  "homepage": "https://github.com/wildcodeschool/create-js-monorepo#readme",
   "bugs": {
-    "url": "https://github.com/wildcodeschool/create-harmonia/issues"
+    "url": "https://github.com/wildcodeschool/create-js-monorepo/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/wildcodeschool/create-harmonia.git"
-  },
-  "bin": {
-    "create-harmonia": "./bin/create-harmonia.js"
+    "url": "git+https://github.com/wildcodeschool/create-js-monorepo.git"
   },
+  "bin": "./bin/create-js-monorepo.js",
   "keywords": [
     "react",
     "express",
+    "mysql",
     "framework"
   ],
   "author": "Wild Code School",

template/.github/workflows/check.yml

@@ -0,0 +1,29 @@
+name: check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - develop
+      - dev
+
+jobs:
+  lint:
+    name: Run checks
+    runs-on: ubuntu-latest
+
+    permissions:
+      checks: write
+      contents: write
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
+
+      - name: Run checks
+        run: biome ci --error-on-warnings --changed --since="origin/${GITHUB_BASE_REF}" .

template/.github/workflows/deploy-traefik.yml

@@ -3,10 +3,10 @@ name: CD-traefik
 on:
   push:
     branches:
-      - main
+      - staging
   pull_request:
     branches:
-      - main
+      - staging
     types: [closed]
 
 jobs:

template/.husky/pre-commit

@@ -20,4 +20,4 @@ fi
 echo '----- Done!'
 
 npx validate-branch-name
-npm run lint
+npm run check