Setup and Installation

Prerequisites

• Docker and Docker Compose installed
• Python 3.x (optional for local development)

Steps

1. Clone the repository:

   git clone https://github.com/roisol144/VirtualBank.git
   cd VirtualBank
   

2. Set up environment variables:

   • Create a .env file in the root directory:

     DATABASE_URL=postgresql://<user>:<password>@db:5432/<dbname>
     SECRET_KEY=<your-secret-key>
     

3. Build and run the Docker containers:

   docker compose up --build
   

4. Access the application:

   • Backend: http://localhost:8000
   • PostgreSQL: localhost:5433 (use a database client)

Usage

Running Tests

(Optional, if tests are implemented)

pytest

API Endpoints

Architecture

Below is the architecture diagram of the VirtualBank system, showcasing the interactions between components:

• Frontend: React application (in development) that interacts with the backend via RESTful APIs.
• Backend (Flask): Handles API requests, user management, and account-related operations.
• Database (PostgreSQL): Stores data for users, accounts, and transactions.
• Docker: Manages the backend and database as separate containers for easy deployment and scaling.

API Documentation

(Detailed endpoint documentation can go here or link to a separate file, e.g., API.md.)

• Example for /register:

  POST /register
  Content-Type: application/json
  {
      "first_name": "John",
      "last_name": "Doe",
      "email": "johndoe@example.com",
      "password": "securepassword"
  }
  

Contributing

I welcome contributions! Here's how you can get involved:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature-name).
3. Commit your changes (git commit -m "Description").
4. Push to your fork (git push origin feature-name).
5. Open a pull request.

License

This Project MIT Licensed.