Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 2.33 KB

README.md

File metadata and controls

49 lines (29 loc) · 2.33 KB

The World Right Now

Travis branch Coverage David version Packagist

Author: Kris Sakarias

Version: 2.0.0

Overview

This is a full-stack application that informs the user about the current social, political, and economic state of the countries in the world.

The back-end server and APIs are built with Node, Express, and MongoDB. All data is courtesy of the CIA World Factbook API (https://github.com/iancoleman/cia_world_factbook_api#data). This data comes in the form of a single very large JSON object, which the app utilizes to perform its basic CRUD functionality. The server does a very large amount of parsing and validation to a ensure a smooth and accurate user experience.

The front-end is built with React. The user can select a country from the dropdown menu to view the latest social, political, and economic information. A series of rankings pages parses and organizes the data so that the user can quickly see how different countries compare against eachother in a variety of different ways.

Political and electoral information is also examined. A country's political system page allows the user to see the type of government, the current leaders (with pictures), future elections, and much more.

The current functionality is described in detail in the front-end and back-end subdirectory READMEs.

Usage

Starting the Server:

git clone https://github.com/kris71990/the_world_right_now.git
cd front-end npm i
cd back-end npm i
mongod

/back-end: npm run start
/front-end: npm run watch

Please consult the back-end and front-end subdirectory READMEs for detailed documentation of the functionality of the app.

Testing

All CRUD functionality in the app is tested using the Jest library.

To run server tests, navigate to the back-end directory and run npm run test

The server's performance has also been tested under load with artillery.io.