Giter VIP home page Giter VIP logo

openclassrooms-13-argent-bank's Introduction

Argent Bank - Frontend

Caution

This repository hosts a project completed as part of my OpenClassrooms training program. Having successfully completed the program, the project has now been archived and will no longer be actively maintained. Please be aware that while the repository will remain accessible for reference, some links or features may no longer function as intended.

p13-preview

Table of contents

Overview

For this project, we have to build a banking application called "Argent Bank". The goal is to use an API to create a frontend application with React and Redux.

Usefull links

Current state

This project is currently in phase 1 of 2. This means that the following features are available:

  • User in database can login and persist his session with a JWT token
  • Unauthenticated user can register
  • User can logout
  • User can see and edit his profile

For the phase 2, we have to deal with the "transactions" feature. Please refer to the Swagger documentation for a proposition of API endpoints to implement.

Prerequisites

If you are using a node version manager like FNM or NVM, you can run fnm use or nvm use to automatically switch to the right node version.

Stack

Please refer to the package.json file for more informations about the dependencies with their version.

Primary stack

Technology/Library Description
React Frontend library
Vite Frontend build tool
(S)CSS Modules CSS modules with SCSS syntax
TypeScript Static type checker
React Router DOM Routing library
React Redux State management library
Axios HTTP client

Code quality

Tool Description
ESLint JavaScript linter
Prettier Code formatter
Stylelint CSS linter

Local setup

Frontend

For this project, we use PNPM as package manager but you can also use NPM or Yarn instead.

  1. Follow the backend installation instructions

  2. Clone the repository

    git clone https://github.com/alexperronnet/openclassrooms-13-argent-bank
  3. Navigate to the project directory

    cd openclassrooms-13-argent-bank
  4. Install the dependencies

    pnpm install
  5. Start the development server

     pnpm run dev
  6. Open your browser and navigate to http://localhost:5173/

Available scripts

Script Description
pnpm run dev Start the development server
pnpm run build Build the project for production
pnpm run preview Preview the production build
pnpm run lint Run the linter
pnpm run lint:fix Run the linter and fix the errors
pnpm run format Run the formatter
pnpm run format:fix Run the formatter and fix the errors
pnpm run stylelint Run the style linter
pnpm run stylelint:fix Run the style linter and fix the errors

Backend

To get more informations about the backend installation, please refer to the backend repository.

If you are a Mac user, you may need to following this issue to install the backend.

If everything is working, the backend should be available at http://localhost:3001/ and the Swagger documentation at http://localhost:3001/api-docs/.

License

This is an OpenClassrooms project. The code is freely reusable, but assets are not because they are not mine. If you are also a student of OpenClassrooms, you can use my work as inspiration but I strongly recommend to not copy/paste any part of it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.