csvinhal / whats-in

Home Page:whats-in-csvinhal.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

What's in App

A simple project made with Nexjs, Typescript, Styled-jsx and Mongo to consume the OMDb API. It also use Jest for unit tests.

The main features are movie listing and detailing. Also possibility to add or remove a movie as a favorite.

Demo

You can see a demo here: What's in App

Setup

Requirements to use this project:

  • Node.js

  • yarn (Package Manager)

  • MongoDB: I'm using a MongoDB to save the favorite movies, so you can either pointer to a MongoDB Container or any other instance of the database you have.

  • Docker*: Just in case you choose using Mongo via Container

How to run

  • Install all de dependecies
$ yarn install
  • Create a .env.local file in the root with using .env.local.example as example.
  • Run with the command:
$ yarn dev

Run tests

To run tests you just need to execute:

$ yarn test

About

whats-in-csvinhal.vercel.app


Languages

Language:TypeScript 94.3%Language:JavaScript 3.3%Language:CSS 2.2%Language:HTML 0.2%