Merge pull request #10 from cherryontech/create-vite-base

Re-set up project with vite/TS, create README, create LICENSE, create contributing.md, create new pull_request_template

.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}

Contributing.md → .github/contributing.md

@@ -15,6 +15,23 @@ Please note we have a code of conduct, please follow it in all your interactions
 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
    do not have permission to do that, you may request the second reviewer to merge it for you.
 
+## Review Guidelines:
+When reviewing, use the following list of comment labels from <a href="https://conventionalcomments.org/">*conventional comments* </a> to make comments clear & quickly parseable.
+
+### Comment Types
+- **Praise:** Highlight positives.
+- **Suggestion:** Propose improvements.
+- **Issue:** Point out problems.
+- **TODO:** Highlight necessary changes.
+- **Question:** Raise concerns for clarification.
+
+### Decorations:
+- (optional): Indicates the comment is not always necessary.
+- (blocking/non-blocking): Specifies urgency level.
+
+*example*: 
+<br>**Issue (non-blocking):** The < h1 > on line 3 is in the incorrect spot. <br>**Praise**: This code is very clear & concise!
+
 ## Code of Conduct
 
 ### Our Pledge

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+
+## Description:
+
+Brief description of the changes introduced in this pull request.
+
+Add Screenshots (if applicable).
+
+## Testing / Acceptance Criteria
+
+- Step-by-step instructions on how to test the changes.
+- Clear acceptance criteria that must be met for this pull request to be considered complete.
+
+## Checklist:
+
+- [ ] I have tested the changes locally.
+- [ ] I have updated the documentation(if applicable).
+

.github/workflows/auto_assign_reviewers.yml

@@ -0,0 +1,24 @@
+# TODO: causing Netlify deployment errors; comment out for testing
+# name: Auto add reviewers
+
+# on:
+#   pull_request_target:
+
+# jobs:
+#   add-reviewers:
+#     runs-on: ubuntu-latest
+
+#     steps:
+#       - name: Add reviewers
+#         uses: actions/github-script@v5
+#         with:
+#           github-token: ${{secrets.GITHUB_TOKEN}}
+#           script: |
+#             const prNumber = context.payload.pull_request.number;
+#             const reviewers = ["adrienne365", "FireL0ki"]; 
+#             github.pulls.requestReviewers({
+#               owner: context.repo.owner,
+#               repo: context.repo.repo,
+#               pull_number: prNumber,
+#               reviewers: reviewers
+#             });

.gitignore

@@ -1,23 +1,24 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# production
-/build
-
-# misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
+# Logs
+logs
+*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

README.md

@@ -1,7 +1,10 @@
-Soft Skills Generator
-Cherry On Tech Spring Cohort 2024
-Saturn Spinners squad
+# Soft Skills Generator
+Cherry On Tech Spring Cohort 2024: Saturn Spinners Squad
 
+## Deployment Status
+[![Netlify Status](https://api.netlify.com/api/v1/badges/678a843c-0add-4fd7-8331-d188405ca866/deploy-status)](https://app.netlify.com/sites/softskill-generator/deploys)
+
+## Overview
 This app was created in response to high occurances of imposter syndrome in individuals, who are new to tech, looking to break into software engineering roles.
 
 The targeted user group is:
@@ -15,4 +18,78 @@ This app helps users identify soft skills previously attained in other industrie
 
 This app is unique in its goal of identifying valuable soft skills with the goal of building confidence in junior developers, rather than seeking to match individuals with specific roles or expose them to job opportunities.
 
-The constraints of this project include not building a BE and only using free technologies.
+The constraints of this project include not building a BE and only using free technologies.
+
+
+## Running the Application
+This is a simple guide to help you get started with setting up and running the application locally.
+
+Prerequisites
+Before you begin, ensure you have the following installed on your system:
+
+- Node.js: Download and install Node.js
+- npm (Node Package Manager): npm is installed automatically with Node.js
+
+
+### Getting Started
+- Clone the repository
+   - `git clone <repository_url>`
+- Navigate to the project directory
+   - `cd soft-skill-generator`
+- Install dependencies
+   - `npm install`
+
+### Running the Application
+
+1. Start the development server: `npm start`
+2. Open your web browser and navigate to:
+http://localhost:3000
+- You should see the application running live!
+
+
+#### Available Scripts
+In the project directory, you can run the following scripts:
+
+- `npm run dev`: Starts the development server and opens the application in your default web browser.
+
+- `npm run build`: Build the project for production. This script compiles the TypeScript code uses TypeScript compiler ('tsc'), then bundles the application using Vite's 'build' command.
+
+- `npm run lint`: Runs ESLint to check formatting & code consistency.
+
+- `npm run preview`: Starts production server to preview a built project locally. Can be used to test production build before deploying to a live environment.
+
+
+If you encounter any issues or have questions about the application, feel free to reach out to us or check out the React documentation for more information.
+
+
+
+## React + TypeScript + Vite (Generated by Vite)
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+export default {
+  // other rules...
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+  },
+}
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list