Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 4.51 KB

README.md

File metadata and controls

101 lines (63 loc) · 4.51 KB

NASA Image Search 🛰️

Background

NASA host an API of image and video assets for public use. I created a simple image search for this asset library.

You can try it out here.

Motivation

My partner proposed this project. He provided a remit which I implemented. This project allowed me to work on a few techs I was already a little familiar with, and try out a few new ones at the same time:

Screenshots

Screenshot of the search engine. The term 'cloud' has been searched. Images related to this are shown, in a grid; most are aerial views of clouds.

Installation

The game is hosted on GitHub Pages and can be run from there.

To install the repo locally:

  1. Clone this repo.
  2. Run npm install from root.
  3. To run the repo locally run npm start.

Using the App

  • Enter a search term into the search field in the page's header, then press enter or click on the magnifying glass in the search field.
  • If the search term matches part of the metadata from any images in the NASA images api, these will be displayed in the area below the header bar. This area is scrollable.
  • If the search term does not match part of the metadata for any of the images in the NASA images API then a message will be displayed stating this.
  • If the server returns an error then the error code and a description of the error state will be displayed below the header bar.
  • A distinct error message is also shown if the user tried to initiate a search without entering a search term into the search field.

Testing

Tests have been written for most of the components of the app. Each component has a render test in the form of a snapshot test. Components with conditional rendering have more extensive tests to assess each of their functions.

Two components do not yet have full tests.

  • getImages (controller) fetches API data. Tests have not been written for this script. This needs to be done.
  • SearchInput (controller) renders the search input field and manages implementation of the getImages controller. A snapshot render test has been written for this component but additional tests are required to check its interaction with the getImages controller.

To run the tests follow the follwing steps:

  1. Open a bash command terminal.
  2. Navigate to this directory.
  3. Enter the command npm test. The tests will run in the console.
  4. Success and fail states will be displayed in the console, along with instructions regarding how to examine and process the test data.

Future Work

  • The outstanding tests detailed above (for the getImages controller and SearchInput component) need to be written and validated.
  • Add media queries to make the app look better on mobile devices.
  • Make the rendered images clickable, and display an enlarged version of the clicked image over the viewport. Include a close button to return the user to the homepage.

Framework

Built with React.
Styled with styled-components.
Tests written with react-testing-library.

Credits

This application uses Open Source components. You can find the source code of their open source projects along with license information below. Huge thanks to all of the people who contribute to this work ❤️️