synopedia

Convenient source for film information

Table of Contents

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

About The Project

This web application serves as a convenient source for searching movie and TV show information.

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

Features

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

Credits

I would like to credit these photographers for being able to use their photos within this project.

• Denise Jans — Light theme background image
• Timothy Eberly — Dark theme background image

Getting Started

Follow these steps to run the web application locally.

Prerequisites

• NodeJS (v16.x)
• npm (v9.x)
• The Movie Database API Bearer Token

Installation

1. Clone the repo

   git clone https://github.com/jackthta/synopedia.git

2. Change into project directory

   cd synopedia

3. Install dependencies

   npm i

4. Make a .env file containing The Movie Database API base URL and bearer token

   VITE_TMDB_BASE_URL="https://api.themoviedb.org/3"
   VITE_TMDB_BEARER_TOKEN=

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 )