sushantdsuwal / ScreenSailor

A command-line tool, that enable users to search movies or TV shows by title, showcasing vital details like title, release year, rating, and plot summary.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ScreenSailor

A command-line tool, that enable users to search movies or TV shows by title, showcasing vital details like title, release year, rating, and plot summary.

Prerequisites

  • Node.js (version 13.2.0 or later recommended)
  • npm (Node Package Manager)

Installation

  1. Clone the repository:

    git clone [https://github.com/sushantdsuwal/ScreenSailor.git](https://github.com/sushantdsuwal/ScreenSailor.git)
    

Navigate to the project directory:

cd ScreenSailor

Install dependencies:

npm install

Run in Development Mode

npm run dev This command uses nodemon to run the project in development mode, automatically restarting the server when changes are detected.

Build

npm run build This command compiles the TypeScript code into JavaScript. The output is typically stored in a build or dist directory.

Start

npm start -- "your search term" This command runs the compiled JavaScript code. Make sure to replace "your search term" with the desired movie search term.

Testing

Run Sample Tests npm run sample_tests Run sample tests using Jest. Customize the test scripts as needed.

Test Coverage npm run coverage Generate test coverage reports using Jest.

About

A command-line tool, that enable users to search movies or TV shows by title, showcasing vital details like title, release year, rating, and plot summary.


Languages

Language:TypeScript 92.9%Language:JavaScript 7.1%