GeekMind00 / Nawyha

A listing apartments app that allow the user to see more details about each apartment.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nawyha

In the heart of Veridian, where the city's pulse thrummed through towering skyscrapers, a revolutionary app called Nawyha reshaped apartment hunting. Created by visionary Mostafa Essam, Nawyha simplified the search with its sleek interface and curated listings.

Sarah, a young professional yearning for the perfect abode, turned to Nawyha. Within moments, she found herself immersed in a world of stunning apartments tailored to her preferences. Filtering options effortlessly, she discovered a charming loft overlooking the city park.

With a few taps, Sarah scheduled a viewing. As she stepped into the sunlit rooms, she knew she had found her sanctuary. Thanks to Nawyha, her dream apartment was no longer just a fantasy—it was a tangible reality.

About The Project

A simple listing apartments app that allow the user to see more details about each apartment.

Functionality requirements:

  • Backend Application:

    • An API endpoint for listing apartments.
    • An API endpoint for getting apartment details.
    • An API for adding apartments.
  • Database:

    • NoSQL database
  • Responsive Frontend Application:

    • Apartment listing page.
    • Apartment details page.
  • Mobile applications:

    • Apartment listing page.
    • Apartment details page.

Built with

Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructions.

Installation

Install docker:

https://docs.docker.com/engine/install/

Clone the repository

git clone git@github.com:GeekMind00/Nawyha.git

Navigate to repository directory

$ cd Nawyha

Project Setup

Create .env file

  • Navigate to the config folder in Backend
$ cd backend/config
  • Add api.env file to current directory with the following variable
MONGO_URI='mongodb://database:27017/nawyha'

Run the Backend & Database

$ docker-compose up

Run the Frontend app on another terminal

$ cd frontend
$ cd npm run dev

Run the Mobile App on another terminal

$ cd mobile\ app
$ cd npm start

Postman Use Case Examples

Nawyha Collection: Containing all the examples of the app routes

About

A listing apartments app that allow the user to see more details about each apartment.


Languages

Language:TypeScript 76.0%Language:JavaScript 23.7%Language:CSS 0.3%