Code Monkey home page Code Monkey logo

argent-bank-frontend's Introduction

Argent-Bank-Frontend

This repository contains the source code for the Argent Bank Frontend app, a platform that allows users to manage their finances conveniently and securely.

Prerequisites

Getting Started

Backend Api

The Argent Bank app relies on a backend API to retrieve data and handle authentication. You can find the source code for the backend API at the following URL: https://github.com/OpenClassrooms-Student-Center/Project-10-Bank-API.

To run the Argent Bank app, you will need to have the backend API running locally as well. Please follow the instructions in the backend API repository's README file to set up and run the API locally. The backend API is responsible for authenticating users and issuing a JWT token.

Once the backend API is up and running, you can start the Argent Bank app by following the instructions in the "Installing" section.

The backend will be available at http://localhost:3001.

Frontend App

Dependencies

This project also has the following dependencies:

"@fortawesome/fontawesome-svg-core": "^6.4.0",
"@fortawesome/free-regular-svg-icons": "^6.4.0",
"@fortawesome/free-solid-svg-icons": "^6.4.0",
"@fortawesome/react-fontawesome": "^0.2.0",
"@reduxjs/toolkit": "^1.9.5",
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^13.4.0",
"@testing-library/user-event": "^13.5.0",
"axios": "^1.4.0",
"prop-types": "^15.8.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-modal": "^3.16.1",
"react-redux": "^8.0.5",
"react-router-dom": "^6.11.1",
"react-scripts": "5.0.1",
"sass": "^1.62.1",
"web-vitals": "^2.1.4"

Please ensure that you have these dependencies installed and up-to-date before running the app.

Installing

  • Clone this repository using the following command:
[email protected]:Yann-GitHub/Argent-Bank-Frontend.git
  • Install the dependencies by running the command:
npm install or yarn install

Running the app

  • Runs the app in the development mode by running the command:
npm start or yarn start

Open http://localhost:3000 to view it in your browser. The page will reload when you make changes. You may also see any lint errors in the console.

Additional API Documentation for Transactions

In addition to the frontend application, we have designed and modeled the API for transactions. To provide a comprehensive understanding of the proposed transaction APIs, we have created a .yalm document conforming to the Swagger format. You can find this document in the file swagger.yaml

The transaction APIs aim to fulfill the following user requirements:

  • View all transactions for the current month.
  • View detailed information about a specific transaction in a separate view.
  • Add, modify, or delete transaction information.

argent-bank-frontend's People

Contributors

yann-github avatar

Watchers

 avatar

argent-bank-frontend's Issues

State management is done through Redux

The React app contains an implementation of Redux for state management that:

  • a store to manage all of the data
  • action(s) for sending information
  • reducer(s) for handling application state changes

User can login to the system

A user should be able to:

  • Navigate to the login page (/login)
  • Fill out credentials
  • Login to the back-end API with JWT tokens for authentication
  • Successfully navigate to a profile page (/profile)

For more information on accessing the design assets, see the Design Assets section in the README.

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.