Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 2.27 KB

README.md

File metadata and controls

82 lines (51 loc) · 2.27 KB

Hackers, The Unofficial Movie API

An API based on the 1995 movie "Hackers". Get information on characters, organizations, hacks, quotes, and more. Inspired by the continued maintenance of Cyberdelia NYC and Hackers Curator by fellow fans. Hack the planet!

Image from Hackers movie

Table of Contents

Introduction

Welcome to the unofficial API for the movie "Hackers". This project was created for the love of a fantastic movie. With that, I wanted to create something that reminded me of the internet in the 90s. I created this to contribute to the fandom around Hackers but also to learn some new skills like containerization and improve my software testing. I hope you enjoy taking a look around.

Getting Started

Get up and running with a few simple steps and no need for checking prerequisites.

Installing

  1. Create your directory, navigate to it, and clone the repo:
git clone https://github.com/internetdrew/hackers-the-api.git .
  1. Create client and server .env files and fill in the credentials:
cp client/.env.example client/.env && cp server/.env.example server/.env
  1. Spin up all containers...
  • ...normally, use this command:

    docker compose up --build
  • ...in detached mode (discreetly, in the background):

     docker compose up -d --build

How to Run API Route Tests

  • Navigate to the server directory and run testing (containers must be running for testing):
cd server && npm run test

Built with:

Monitored with:

Measured with:

Tested with:

Deployed with: