API Documentation

Home

Build Status Quality Gate Status Coverage GitHub pages

BnB Explorer Frontend

Open Project Documentation

  • Source code documentation can be found here

.env File

For the submission of the project, the .env file is already included in the zipped project deliverable. Otherwise, to use the project, a .env file is required, containing the following two entries.

REACT_APP_API_URL= #your backend URL
REACT_APP_GOOGLE_MAPS_API_KEY= #your google api key here

Additionally, Google places and Maps JS API need to be enabled for your API key.

Running with Docker

To run the full project, including the backend, the setup guidelines can be found here.

The recommended way to run the frontend of the project is to run it in a Docker container.
Thus, the following commands need to be entered in the root directory.

# building the frontend image
docker build -t frontend .

# starting the container
docker run -p 3000:3000 frontend

Local Project Setup

Prerequisites

  • To install the project, npm and node are needed
  • The application was tested with Node 14, though other versions may work as well

Installation & Running the app

To install and run the project locally, enter these commands in the root directory:

# install the project
npm i

# run the project
npm start