Merge pull request #473 from mattlean/v1.1.0-rc

v1.1.0

Author: mattlean

.eslintrc.js

@@ -1,14 +1,14 @@
 module.exports = {
-    env: {
-        es2024: true,
-        node: true,
-    },
-    extends: ['eslint:recommended', 'prettier'],
-    parserOptions: {
-        ecmaVersion: 'latest',
-        sourceType: 'module',
-    },
-    root: true,
-    rules: {},
-    overrides: [],
-}
+  env: {
+    es2024: true,
+    node: true,
+  },
+  extends: ["eslint:recommended", "prettier"],
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  root: true,
+  rules: {},
+  overrides: [],
+};

.husky/install.mjs

@@ -1,6 +1,6 @@
 // Skip Husky install in production and CI
-if (process.env.NODE_ENV === 'production' || process.env.CI === 'true') {
-    process.exit(0)
+if (process.env.NODE_ENV === "production" || process.env.CI === "true") {
+  process.exit(0);
 }
-const husky = (await import('husky')).default
-console.log(husky())
+const husky = (await import("husky")).default;
+console.log(husky());

.prettierrc.json

@@ -1,9 +1,6 @@
 {
-    "importOrder": ["<THIRD_PARTY_MODULES>", "^[./]"],
-    "importOrderSeparation": true,
-    "importOrderSortSpecifiers": true,
-    "plugins": ["@trivago/prettier-plugin-sort-imports"],
-    "semi": false,
-    "singleQuote": true,
-    "tabWidth": 4
+  "importOrder": ["<THIRD_PARTY_MODULES>", "^[./]"],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"]
 }

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-    "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
 }

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-    "editor.formatOnSave": true
+  "editor.formatOnSave": true
 }

CHANGELOG.md

@@ -1,42 +1,52 @@
-## 1.0.0
+## 1.1.0
 
--   Introduce Docker dev environments for all projects except for Electron-based projects
--   Introduce PostgreSQL support with new Express + PostgreSQL starters: `express-postgres` & `react-express-postgres-ssr`
--   Introduce dotenv ^16.4.5
--   Introduce Mock Service Worker ^2.2.2
--   Introduce Prettier 3.2.5
--   Introduce Prisma ^4.15.0
--   Introduce Playwright ^1.44.0
--   Introduce `electron-icon-maker` ^0.0.5
--   Replace Enzyme with React Testing Library ^14.2.1
--   Add DOM Testing Library ^9.3.4 for non-React frontend projects
--   Replace Flow and PropTypes with TypeScript ~5.3.3
--   Replace React Hot Loader with React Refresh ^0.14.0
--   Replace Sublime Text support with Visual Studio support
--   Drop support for Yarn
--   Upgrade Babel to ^7.22.1
--   Upgrade Electron to 29.1.0
--   Upgrade ESLint to ^8.41.0
--   Upgrade Express to ^4.18.2
--   Upgrade Jest to ^29.5.0
--   Upgrade Node.js to ^20.9.0
--   Upgrade React to ^18.2.0
--   Upgrade SuperTest to ^6.3.3
--   Upgrade Stylelint to ^16.2.1
--   Upgrade webpack to ^5.85.0
--   Separate asset test and counter from `browser` project into its own examples: `asset-test` & `counter-react`
--   Replace Node Sass with Dart Sass ~1.64.2 for `counter-react`
--   Rewrite \*chan from `nodejs-ssr` project into its own `starchan` example
--   Upgrade `react-redux` to ^8.1.3 for `starchan`
--   Setup Redux Toolkit ^1.9.6 for `starchan`
--   Upgrade React Router to ^6.16.0 for `starchan`
--   Port `todolist-browser` project as `todo-list` example
--   Create new vanilla JavaScript starter for browsers: `basic-browser`
--   Create new vanilla JavaScript starter for desktops: `basic-electron`
--   Create new vanilla JavaScript starter for Node.js: `basic-node`
--   Create new Express + MongoDB starter: `express-mongo`
--   Create new React starter for browsers: `react-browser`
--   Create new React starter for desktops: `react-electron`
--   Create new React + Express + MongoDB server-side rendering starter: `react-express-mongo-ssr`
--   Create new desktop app example: `markdown-editor`
--   Create new Express + PostgreSQL example: `notes-api`
+- Create new React app example: `tic-tac-toe`
+- Create `CONTRIBUTING.md`
+- Update code formatting to use Prettier defaults
+- Update `react` package to ^18.3.1
+- Update `express` package to ^4.21.1
+- Update `prisma` & `@prisma/client` packages to ^4.16.2
+- Make minor fixes and adjustments to configurations and docs
+
+## 1.0.0 (Nov. 4, 2024)
+
+- Introduce Docker dev environments for all projects except for Electron-based projects
+- Introduce PostgreSQL support with new Express + PostgreSQL starters: `express-postgres` & `react-express-postgres-ssr`
+- Introduce dotenv ^16.4.5
+- Introduce Mock Service Worker ^2.2.2
+- Introduce Prettier 3.2.5
+- Introduce Prisma ^4.15.0
+- Introduce Playwright ^1.44.0
+- Introduce `electron-icon-maker` ^0.0.5
+- Replace Enzyme with React Testing Library ^14.2.1
+- Add DOM Testing Library ^9.3.4 for non-React frontend projects
+- Replace Flow and PropTypes with TypeScript ~5.3.3
+- Replace React Hot Loader with React Refresh ^0.14.0
+- Replace Sublime Text support with Visual Studio support
+- Drop support for Yarn
+- Upgrade Babel to ^7.22.1
+- Upgrade Electron to 29.1.0
+- Upgrade ESLint to ^8.41.0
+- Upgrade Express to ^4.18.2
+- Upgrade Jest to ^29.5.0
+- Upgrade Node.js to ^20.9.0
+- Upgrade React to ^18.2.0
+- Upgrade SuperTest to ^6.3.3
+- Upgrade Stylelint to ^16.2.1
+- Upgrade webpack to ^5.85.0
+- Separate asset test and counter from `browser` project into its own examples: `asset-test` & `counter-react`
+- Replace Node Sass with Dart Sass ~1.64.2 for `counter-react`
+- Rewrite \*chan from `nodejs-ssr` project into its own `starchan` example
+- Upgrade `react-redux` to ^8.1.3 for `starchan`
+- Setup Redux Toolkit ^1.9.6 for `starchan`
+- Upgrade React Router to ^6.16.0 for `starchan`
+- Port `todolist-browser` project as `todo-list` example
+- Create new vanilla JavaScript starter for browsers: `basic-browser`
+- Create new vanilla JavaScript starter for desktops: `basic-electron`
+- Create new vanilla JavaScript starter for Node.js: `basic-node`
+- Create new Express + MongoDB starter: `express-mongo`
+- Create new React starter for browsers: `react-browser`
+- Create new React starter for desktops: `react-electron`
+- Create new React + Express + MongoDB server-side rendering starter: `react-express-mongo-ssr`
+- Create new desktop app example: `markdown-editor`
+- Create new Express + PostgreSQL example: `notes-api`

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing
+
+Thanks for your willingness to contribute to Lean JS App Starter! Here is an overview of the contribution process.
+
+## Finding or Creating Issues
+
+First, take a look through the GitHub repository's issue page:
+https://github.com/mattlean/lean-js-app-starter/issues
+
+Then, see the GitHub project board to view what tickets the LJAS core team is currently prioritizing:
+https://github.com/users/mattlean/projects/3
+
+If you want to work on something that isn't on the issue page or project board, then feel free to create a new issue. Note that sometimes the board contains tickets that don't have a corresponding issue yet which means that the LJAS core team does have plans to work on it. So even if you don't see an issue for something, make sure there isn't an existing ticket for it on the project board too before creating a brand new issue.
+
+## Branches & Commits
+
+Every development version has what we call a **development branch** which holds all of the work that is intended for that version's release. The development branch will always have a `-dev` suffix at the end of its name. For example, if the upcoming version is 1.1.0, then the development branch name will be `v1.1.0-dev`.
+
+When you want to work on something, branch off of the development branch and work off of that. This is what we call a **feature branch**. Its name should follow a particular convention where it starts with the issue number it is attempting to resolve followed by an underscore, and then a title that is relevant to the issue. For example, if the issue number is 464 and the issue title is "Create tic-tac-toe example", then an appropriate feature branch name could be `464_tic-tac-toe`.
+
+Once you're ready to make a pull request, [squash all of the commits in your feature branch into one commit](https://git-tower.com/learn/git/faq/git-squash), set its commit message to something relevant to the issue, and end the message with the issue number prefixed with a # sign. For example, if the issue number is 464 and the issue title is "Create tic-tac-toe example", then an appropriate commit message could be "Create tic-tac-toe example #464".
+
+## Pull Requests
+
+Push the feature branch to the GitHub repository and then make a pull request from it that merges into the development branch. The title of the pull request should be relevant to the issue, and its description should [reference the issue number](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls). For example, if your feature branch was named `464_tic-tac-toe` and the version you're developing is 1.1.0, you would set the pull request's base branch to `v1.1.0-dev`. Its title could be "Create tic-tac-toe example" and its description should include "Resolves issue #464."
+
+If you want to preserve your Git commit history, you can push another branch that has your work's complete, unsquashed commit history with `_dev` appended to the end of its feature branch name. This will not be merged, but it can be kept in the repository for reference and back-up purposes. Please include a link to this branch in the pull request's description.
+
+## Review Process
+
+Now that your pull request is ready, assign a reviewer from the LJAS core team on it. They will review your work, test it, and reply with feedback. They will notify you if the code needs more work or not. Once the code is in an acceptable state, the pull request will be approved by the reviewer and will be acceptable for merging into the development branch.
+
+Once the development branch is completely ready, it will be merged into the `master` branch by the LJAS core team, and your work will go into the new release version.