add base code and doc for final project b00tc4mp#240

manuelbarzi · Apr 18, 2024 · 707738a · 707738a
1 parent bae277b
commit 707738a
Show file tree

Hide file tree

Showing 16 changed files with 347 additions and 0 deletions.
diff --git a/staff/manuel-barzi/project/api/.gitignore b/staff/manuel-barzi/project/api/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/staff/manuel-barzi/project/api/index.js b/staff/manuel-barzi/project/api/index.js
diff --git a/staff/manuel-barzi/project/api/package.json b/staff/manuel-barzi/project/api/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "api",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}
diff --git a/staff/manuel-barzi/project/app/.eslintrc.cjs b/staff/manuel-barzi/project/app/.eslintrc.cjs
@@ -0,0 +1,21 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  settings: { react: { version: '18.2' } },
+  plugins: ['react-refresh'],
+  rules: {
+    'react/jsx-no-target-blank': 'off',
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/staff/manuel-barzi/project/app/.gitignore b/staff/manuel-barzi/project/app/.gitignore
@@ -0,0 +1,24 @@
+# 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?
diff --git a/staff/manuel-barzi/project/app/README.md b/staff/manuel-barzi/project/app/README.md
@@ -0,0 +1,8 @@
+# React + 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
diff --git a/staff/manuel-barzi/project/app/index.html b/staff/manuel-barzi/project/app/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>
diff --git a/staff/manuel-barzi/project/app/package.json b/staff/manuel-barzi/project/app/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "app",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.66",
+    "@types/react-dom": "^18.2.22",
+    "@vitejs/plugin-react": "^4.2.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.34.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.6",
+    "vite": "^5.2.0"
+  }
+}
diff --git a/staff/manuel-barzi/project/app/public/vite.svg b/staff/manuel-barzi/project/app/public/vite.svg
diff --git a/staff/manuel-barzi/project/app/src/App.css b/staff/manuel-barzi/project/app/src/App.css
@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
diff --git a/staff/manuel-barzi/project/app/src/App.jsx b/staff/manuel-barzi/project/app/src/App.jsx
@@ -0,0 +1,35 @@
+import { useState } from 'react'
+import reactLogo from './assets/react.svg'
+import viteLogo from '/vite.svg'
+import './App.css'
+
+function App() {
+  const [count, setCount] = useState(0)
+
+  return (
+    <>
+      <div>
+        <a href="https://vitejs.dev" target="_blank">
+          <img src={viteLogo} className="logo" alt="Vite logo" />
+        </a>
+        <a href="https://react.dev" target="_blank">
+          <img src={reactLogo} className="logo react" alt="React logo" />
+        </a>
+      </div>
+      <h1>Vite + React</h1>
+      <div className="card">
+        <button onClick={() => setCount((count) => count + 1)}>
+          count is {count}
+        </button>
+        <p>
+          Edit <code>src/App.jsx</code> and save to test HMR
+        </p>
+      </div>
+      <p className="read-the-docs">
+        Click on the Vite and React logos to learn more
+      </p>
+    </>
+  )
+}
+
+export default App
diff --git a/staff/manuel-barzi/project/app/src/assets/react.svg b/staff/manuel-barzi/project/app/src/assets/react.svg
diff --git a/staff/manuel-barzi/project/app/src/index.css b/staff/manuel-barzi/project/app/src/index.css
@@ -0,0 +1,68 @@
+:root {
+  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
diff --git a/staff/manuel-barzi/project/app/src/main.jsx b/staff/manuel-barzi/project/app/src/main.jsx
@@ -0,0 +1,10 @@
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import App from './App.jsx'
+import './index.css'
+
+ReactDOM.createRoot(document.getElementById('root')).render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+)
diff --git a/staff/manuel-barzi/project/app/vite.config.js b/staff/manuel-barzi/project/app/vite.config.js
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import react from '@vitejs/plugin-react'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+})
diff --git a/staff/manuel-barzi/project/doc/README.md b/staff/manuel-barzi/project/doc/README.md
@@ -0,0 +1,78 @@
+# Pepito App
+
+## Intro
+
+blah blah ...
+
+![](https://media.giphy.com/media/l0IyhjkozSEjMPBXq/giphy.gif?cid=ecf05e47hbea8uizspfe2h405xb7c7tb4j6py88nips4za6r&ep=v1_gifs_search&rid=giphy.gif&ct=g)
+
+## Functional Description
+
+### Use Cases
+
+- search bikes
+- book bikes
+- list book history
+- report an issue
+- add review
+
+### UI Design
+
+TODO Figma
+
+## Technical Description
+
+### Technologies
+
+- JavaScript
+- React
+- Node
+- Express
+- Mongo
+
+## Modules
+
+- API (server)
+- App (client)
+
+### Data Model
+
+User
+- id (string, required)
+- name (string, required)
+- email (string, required)
+- username (string, required)
+- password (string, required)
+
+Bike
+- id (string, required)
+- brand (string, required)
+- model (string, required)
+- type (string, required, enum: urban|mountain|beach)
+- color (string, optional)
+- reserved (boolean, required)
+
+Booking
+- id (string, required)
+- user (User.id)
+- bike (Bike.id)
+- from (date, required)
+- to (date, required)
+
+Issue
+- id (string, required)
+- user (User.id)
+- bike (Bike.id)
+- subject (string, required)
+- body (string, optional)
+- date (date, required)
+- status (string, required, enum: open|closed)
+
+Review
+- id (string, required)
+- user (User.id)
+- bike (Bike.id)
+- subject (string, required)
+- body (string, optional)
+- rate (number, required, enum: 1|2|3|4|5)
+