Country Details

Table of Contents

• Project Description
  • Platform Used
  • Deployed Live Demo
• Getting Started
  • Prerequisites
  • Setup
  • Usage
  • Run tests

Country Details

Country Details is an app where you can search for different countries and see information regarding them.

Platform Used

Client - React.js

Server - Node.js, Express

(back to top)

Deployed Live Demo

Client and Server are deployed using heroku

• Country Details Demo

Deployed Server Side URL

• https://countrydetails-api.herokuapp.com

(back to top)

Getting Started

Clone the code from GitHub and unzip it. Folder named frontend holds the React.js Client code while the folder backend holds the Node.js Server code.

Prerequisites

In order to run this project you need:

1. Node.js
2. npm

Setup

Server Side:

  cd frontend

  npm install

Client Side:

  cd backend

  npm install

Create a .env.local file and add the value for REACT_APP_API_URL as the url of the localhost with port server is run on. eg: http://localhost:3001

Usage

Server Side:

  npm start

Client Side:

  npm start

Run tests

We use Jest for unit testing on the Server side and Cypress for e2e testing on the Client side. To run tests, run the following command:

Server Side:

  npm test

Client Side:

  npx cypress run

(back to top)