Argent Bank

Introduction

Argent Bank is a new start-up in the banking industry.

Installation

Front-end Prerequisites

• Visual Studio Code (or your preferred IDE)
• Git
• NodeJS (version 18.15.0) - includes NPM 9.5.0
• NPM (version 9.5.0)

Install and launch the front-end

1. Fork this repository

• Click on the fork button in the top right corner of the repository page.

2. Clone the forked respository to your local machine

• Replace the url below with the url of your forked repository.

  https://github.com/your-username/project-name.git

• Open a terminal window and navigate to the directory that will store your project.

  cd project-name

• In your terminal, run the command below. The dot at the end will clone the project into the current directory.

  git clone https://github.com/your-username/project-name.git .

3. Install the front-end dependencies

• In your terminal, run the commands below to install the dependencies listed in the package.json file.

  cd Front
  npm install

4. Launch the front-end

• In your terminal, run the command below to launch the project.

  npm run dev

  The front-end of the project will launch in your browser at http://localhost:5173

  ---

Install and launch the back-end

You can skip forking and cloning the back-end repository, since it is included in this repository.

1. Before installing the back-end dependencies:

   Open a new terminal window, and navigate to the back-end directory from the root of your project:

   cd Back

2. See the instructions in the Back-end ReadMe to install the dependencies, launch the back-end, populate the database, and see the API documentation.

3. In the Back/server/database/connection.js file of the back-end repository, verify that you have the updated database URL:

   # original URL
   const databaseUrl =
       process.env.DATABASE_URL || 'mongodb://localhost/argentBankDB'
   
   # updated URL
   const databaseUrl =
       process.env.DATABASE_URL || 'mongodb://127.0.0.1/argentBankDB'

---

Front-end Technologies

Quick Link

YAML swagger file of proposed API models with endpoints required for phase 2: Transactions