Argent-bank

README.md

@@ -1,4 +1,4 @@
-# Project #10 - Argent Bank API
+# Project #13 - Argent Bank API
 
 This codebase contains the code needed to run the backend for Argent Bank.
 
@@ -10,47 +10,80 @@ Argent Bank uses the following tech stack:
 
 - [Node.js v12](https://nodejs.org/en/)
 - [MongoDB Community Server](https://www.mongodb.com/try/download/community)
+- [Git](https://git-scm.com)
+- [Node.js v12](https://nodejs.org/en/)
+- [MongoDB Community Server](https://www.mongodb.com/try/download/community)
+  Please make sure you have the right versions and download both packages. You can verify this by using the following commands in your terminal:
 
-Please make sure you have the right versions and download both packages. You can verify this by using the following commands in your terminal:
+### Dépendances :
 
-```bash
-# Check Node.js version
-node --version
+- [React](https://reactjs.org)
+- [React-router-dom](https://reactrouter.com/): ^6.23.1
+- [React-redux](https://react-redux.js.org/): ^9.1.2
+- [@reduxjs/toolkit](https://redux-toolkit.js.org/): ^2.2.5
 
-# Check Mongo version
-mongo --version
-```
+Your server should now be running at http://locahost:3001 and you will now have two users in your MongoDB database!
 
-### Instructions
+## Populated Database Data
 
-1. Fork this repo
-1. Clone the repo onto your computer
-1. Open a terminal window in the cloned project
-1. Run the following commands:
+Once you run the `populate-db` script, you should have two users in your database:
 
-```bash
-# Install dependencies
-npm install
+## API Documentation
 
-# Start local dev server
-npm run dev:server
+To learn more about how the API works, once you have started your local environment, you can visit: http://localhost:3001/api-docs
 
-# Populate database with two users
-npm run populate-db
-```
+## Design Assets
 
-Your server should now be running at http://locahost:3001 and you will now have two users in your MongoDB database!
+Static HTML and CSS has been created for most of the site and is located in: `/designs`.
 
-## Populated Database Data
+For some of the dynamic features, like toggling user editing, there is a mock-up for it in `/designs/wireframes/edit-user-name.png`.
 
-Once you run the `populate-db` script, you should have two users in your database:
+And for the API model that you will be proposing for transactitons, the wireframe can be found in `/designs/wireframes/transactions.png`.
+
+## Installation :
+
+### Installation Procedure:
+
+Clone the repository:
+
+- git clone https://github.com/Gizmoux/Project-10-Bank-API.git
+
+### Installation and launching of the Back-end:
+
+1. Go to the Argent-bank folder
+
+   - cd Argent-bank
+
+2. Check Node version:
+
+   - `node --version`
+
+3. Check MongoDB version:
+
+   - `mongo --version`
+
+4. Install all dependencies for the back-end:
+
+   - `npm install` or `yarn`
+
+5. Launch the back-end with Node 16 (nvm) and create 2 users in the database:
+
+```bash
+nvm use 16
+npm run dev:server
+npm run populate-db
+```
+
+## Users in database:
 
 ### Tony Stark
 
 - First Name: `Tony`
 - Last Name: `Stark`
 - Email: `[email protected]`
 - Password: `password123`
+- token : eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY2OGZlMWI5NWU2YWE5MmEzYzExNzliMCIsImlhdCI6MTcyNzA4MzUwMCwiZXhwIjoxNzI3MTY5OTAwfQ.z8e79HaeqW_KVSWiyWlJ6KmnW5W66dmKt-JY8OCpljs
+- Méthode POST sur postman : http://localhost:3001/api/v1/user/login avec le bearer token que l'on a récupéré depuis la route /login
 
 ### Steve Rogers
 
@@ -59,14 +92,18 @@ Once you run the `populate-db` script, you should have two users in your databas
 - Email: `[email protected]`,
 - Password: `password456`
 
-## API Documentation
+### Installation and launch of the front-end in a new terminal:
 
-To learn more about how the API works, once you have started your local environment, you can visit: http://localhost:3001/api-docs
+1. Go to the argent-bank folder:
 
-## Design Assets
+   - cd argent-bank
 
-Static HTML and CSS has been created for most of the site and is located in: `/designs`.
+2. Install all dependencies and launch the frontend:
 
-For some of the dynamic features, like toggling user editing, there is a mock-up for it in `/designs/wireframes/edit-user-name.png`.
+```bash
+cd argent-bank
+npm run dev
+```
 
-And for the API model that you will be proposing for transactitons, the wireframe can be found in `/designs/wireframes/transactions.png`.
+The front-end will be launched at the URL:
+`http://localhost:5173/`

argent-bank/.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 },
+    ],
+  },
+}

argent-bank/.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?

argent-bank/README.md

@@ -0,0 +1,35 @@
+# React + TypeScript + 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
+
+# Start
+
+- cd argent-bank
+- npm run dev

argent-bank/index.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
+		<script
+			src="https://kit.fontawesome.com/25a6e78e8b.js"
+			crossorigin="anonymous"
+		></script>
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Argent Bank</title>
+	</head>
+	<body>
+		<div id="root"></div>
+		<script type="module" src="/src/main.tsx"></script>
+	</body>
+</html>