README.md

Image Gallery

A searchable gallery of images

Table of Contents

1. About The Project
   • Built With
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. Tests

About The Project

This web application features an infinite scroll image gallery. Search for keywords to filter down images to your liking.

Built With

• 
• 
• 
• 
• 
• 

Features

• Accessibility ♿️
• Responsive Web Design 📱 💻 🖥
• Light & Dark Mode ☀️ 🌑

Getting Started

Follow these steps to run the web application locally.

Prerequisites

• NodeJS (v16.x)
• npm (v9.x)
• Unsplash Image API Keys

Installation

1. Clone the repo

   git clone https://github.com/jackthta/Image-Gallery.git

2. Change into project directory

   cd Image-Gallery

3. Install dependencies

   npm i

4. Create an .env file and set your Unsplash Image API keys

   VITE_UNSPLASH_ACCESS_KEY=
   VITE_UNSPLASH_SECRET_KEY=

5. Launch the web application

   npm run dev

Tests

The testing framework used in this project is Cypress. The documentation can be found here.

Run tests

To run the tests located in the cypress/e2e directory, run this command:

npm run test

( 🔺 back to top )