andrewjamesford / Mission-5-group-5

Metro Property Management Website

Metro Property Management Website is a web application designed to help users search for and manage properties. The application consists of a frontend and a backend, both of which are containerized using Docker Compose for easy deployment.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Development
  • Frontend
  • Backend
• Docker Compose
• Troubleshooting
• License

Getting Started

Prerequisites

Make sure you have the following tools installed:

• Docker
• Node.js
• npm (Node.js package manager)

Installation

1. Clone the repository:

   git clone <repository-url>
   cd <repository-folder>

2. Install dependencies for both frontend and backend:

   # Frontend
   cd client
   npm install
   
   # Backend
   cd ../server
   npm install

Usage

To run the application locally, use the following commands:

# Start Docker Compose
docker-compose up

# Access the application
Open your browser and go to http://localhost:3000

Development

Frontend

• Run the frontend in development mode:

  cd client
  npm run dev

• Build the frontend:

  cd client
  npm run build

Backend

• Run the backend in development mode:

  cd server
  npm run dev

• Run tests:

  cd server
  npm test

Docker Compose

The application is containerized using Docker Compose. To build and start the containers, use the following commands:

docker-compose up --build

Troubleshooting

If you encounter any issues, try the following:

• Check if all dependencies are installed.
• Restart Docker Compose.
• ...