Proprio Backend

An application designed to simplify the process of renting and leasing properties in Haiti.

Technologies

• Backend Framework: AdonisJs
• Database: PostgreSQL
• File Storage: Cloudflare R2
• Containerization: Docker, Traefik

Features

• User authentication and management
• Property listings with photos and descriptions
• Message system for user communication
• Advanced search and filtering for properties
• User reviews and ratings for properties
• Favorites management

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v14.x or higher)
• npm (v6.x or higher)
• PostgreSQL
• Optional (for Docker setup): Docker

Installation

1. Clone the repository:

   https://github.com/pwopryo/pwopryo-api.git
   cd pwopryo-api

2. Install dependencies:

   npm install

3. Set up environment variables: Create a .env file in the root directory and add your database and other configuration details.

4. Run database migrations and Seed data:

   node ace migration:run
   node ace db:seed

Running the Application

1. Start the AdonisJs server:

   npm run dev

2. The API will be available at http://localhost:3333.

Optional: Running with Docker

1. Ensure Docker is installed.

2. Build and start the containers:

   docker-compose up --build

3. The API will be available at http://localhost:3333.