An open API service indexing awesome lists of open source software.

https://github.com/micheld-dev/argentbank-front

Utilisez une API pour un compte utilisateur bancaire avec React - Formation OpenClassrooms projet 13
https://github.com/micheld-dev/argentbank-front

eslint husky jsdoc lint-staged react-final-form react-router reactjs redux-persist redux-toolkit redux-toolkit-query swagger typescript vite zod

Last synced: 4 months ago
JSON representation

Utilisez une API pour un compte utilisateur bancaire avec React - Formation OpenClassrooms projet 13

Awesome Lists containing this project

README

        

# Argent Bank

---

#### API et authentification pour une application de compte bancaire.

#### Formation OpenClassrooms - Développeur d'applications JavaScript React

#### Projet 13

(back to top)

## Pré-requis

Argent Bank utilise le stack technique suivant:

- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Node&message=>=14.0.0&color=informational?style=for-the-badge&logo=node)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=MongoDB-Community-Server&message=v6.0.4&color=informational?style=for-the-badge&logo=mongodb)

Assurez vous que vous disposez bien de l'ensemble des packages, ainsi que de
leur version. Vous pouvez vérifier celle-ci en entrant les commandes suivantes
dans votre terminal:

```bash
# Vérifiez la version de Node.js
node --version

# Vérifiez la version de Mongo
mongo --version
```

(back to top)

## Dépendances

- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Vite&message=v4.0.0&color=informational?style=for-the-badge&logo=vite)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=React&message=v18.2.0&color=informational?style=for-the-badge&logo=react)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Axios&message=v1.2.3&color=informational?style=for-the-badge&logo=axios)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Redux-Toolkit&message=v1.9.1&color=informational?style=for-the-badge&logo=redux)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Redux-Persist&message=v6.0.0&color=informational?style=for-the-badge&logo=redux)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Redux-Query&message=v6.0.0&color=informational?style=for-the-badge&logo=redux)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=React-Final-Form&message=v6.5.9&color=informational?style=for-the-badge&logo=react-final-form)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=React-Router&message=v6.6.2&color=informational?style=for-the-badge&logo=react-router)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Zod&message=v3.20.2&color=informational?style=for-the-badge&logo=zod)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=EsLint&message=v8.31.0&color=informational?style=for-the-badge&logo=eslint)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Prettier&message=v2.8.3&color=informational?style=for-the-badge&logo=prettier)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=JsDoc&message=v4.0.0&color=informational?style=for-the-badge&logo=jsdoc)
- ![GitHub package.json dependency version (prod)](https://img.shields.io/static/v1?label=Sass&message=v1.57.1&color=informational?style=for-the-badge&logo=sass)

(back to top)

## L'architecture du projet :

Ce projet, dit frontend, est connecté à un service API backend que vous devez
aussi lancer en local.

Le projet backend se trouve ici: https://github.com/MichelD-dev/ArgentBank-back

(back to top)

## Organiser son espace de travail :

Pour une bonne organisation, vous pouvez créer un dossier ArgentBank dans lequel
vous allez cloner le projet backend et par la suite, le projet frontend:

Dans le dossier ArgentBank, créer deux dossiers ArgentBank-back et
ArgentBank-front:\*\*\*\*

Initialiser chacun:

```bash
$ git init
```

Copier dans ArgentBank-back le code Backend :

```bash
$ git clone ttps://github.com/MichelD-dev/ArgentBank-back
```

Copier dans ArgentBank-front le code frontend :

```bash
$ git clone https://github.com/MichelD-dev/ArgentBank-Front
```

(back to top)

Ouvrir chaque dossier dans un terminal différent :

- Terminal 1:

```bash
$ cd ArgentBank-back
```

```bash
$ npm i
```

ou

```bash
$ yarn
```

Pour lancer le back:

```bash
$ npm run dev:server
```

ou

```bash
$ yarn dev:server
```

(back to top)

- Terminal 2:

```bash
$ cd ArgentBank-front
```

```bash
$ npm i
```

ou

```bash
$ yarn
```

Pour lancer le front:

```bash
$ npm run dev
```

ou

```bash
$ yarn dev
```

Si le site n’est pas lancé automatiquement : Ouvrir le navigateur à l'adresse:
http://localhost:5173/


Vous disposez pour vous connecter des profils des deux utilisateurs suivants:
### Tony Stark

- First Name: `Tony`
- Last Name: `Stark`
- Email: `[email protected]`
- Password: `password123`

### Steve Rogers

- First Name: `Steve`,
- Last Name: `Rogers`,
- Email: `[email protected]`,
- Password: `password456`

(back to top)

Vous pouvez générer de la documentation au format JsDoc avec la commande
suivante

```bash
npm run doc
```

ou

```bash
yarn doc
```

Pour la consulter, allez dans le répertoire `/docs`, puis ouvrez `index.html`
avec live-server.

(back to top)

---

## Contact:

Michel DELAUNAY - [email protected]

## Linkedin:

https://www.linkedin.com/in/michel-delaunay/

(back to top)