/BE-Studio-Ghibli-Tracker

Backend of Ghibli app that allows you to view the entire catalog of films produced by the Ghibli studio.

Primary LanguageTypeScriptMIT LicenseMIT

BE-Studio-Ghibli-Traker

Studio Ghibli Tracker is a web application that allows us to view the catalog of films produced by Studio Ghibli, as well as register a personal rating and keep track of which ones you have already seen and which ones you have not yet.

Conig-environment

The environment is created in Nest.js using Node.js.

Built With

The next thecnologies were added to build and run this project.

  • Node.js
  • Nest.js
  • PostgreSQL

Getting Started

Would you like to run this amazing app in you local area? So follow the next steps, they are really helpful:

Prerequisites

In order to execute the project, it is necessary the latest version of npm.

npm install npm@latest -g

Installation

Perfect! Let's clone the repo, and install the dependencies of the project.

  1. Clone the repo 
    git clone git@github.com:C10-Ghibli-s/BE-Studio-Ghibli-Tracker.git
  2. Install NPM packages 
    npm install
  3. Install Node
# Using Ubuntu
curl -fsSL https://deb.nodesource.com/setup_17.x | sudo -E bash -
sudo apt-get install -y nodejs

Linter Code

ESLint was implemented in this project. To run the lint use the following command.

npm run lint

The DataBase Modeling

We identify seven entities from studio ghibli tracker. They are users, movies, titles, scores, writers, directors and musicians, only two of them are strong entites which are users and movies; the other ones are weak entities. In the next picture is shown the ER diagram and the relationship that entities have each other.

ER diagram for studio ghibli tracker

With this driagram in mind we are able to create the physical diagram with the types of data for each attribute of the entities in the DataBase, in the following image you can see it, also it contains the foreign keys and contraints of the models.

Physical diagram

[C10-Squad-Search-Engine]💚 Platzi Master






Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.