Prodap Test

Icecream challenge

This is a test case for PRODAP. It consists on an API to manage an icecream store stock. (You can read the entire case on Case-dev-senior.pdf).

The IceCream API use the feathers framework (https://feathersjs.com/) .

Features

• Create stocks of icecream
• Easily integrates with any app consumer using feathers client, Socket.io client or REST consumer
• Optimized for offline-first use

Stack

The IceCream API uses a number of open source projects to work properly:

• [Node JS] - JavaScript Runtime
• [Typecript] - Extend your javascript with types and future features!
• [FeathersJS] - A modern node framework transport agnostic focused on realtime applications.

Installation

The IceCream API requires Node.js v14, and a Mongo replica set running.

The easiest way to install it is to use docker and the VSCode DevContainer extension.

Installation with devcontainer

Open the project with VSCode, access the command palette (usually F1) and enter the option "Open Folder in Container". It will start a remote container session. To start a replica set you're gonna need to enter the mongo container shell and run

mongo

rs.initiate()

Once this setup is finished, you can start a terminal inside VSCode and run

npm install
npm run tests
npm run dev

Bare Installation

Install the dependencies (Mongo as a replica set and Node 14) and run the commands:

cd prodap-test
npm i
npm run test
npm run dev

Project Structure

• .devcontainer - Contain files for VSCode Dev Containers run. It consists on simple docker and docker-compose files. You can try these files if you want to run the project without the dev containers extension.

• src - Where our code lives

• • common-types - Generic interfaces and types
• • middleware - Generic middlewares
• • models - Our application models
• • services - Our application services. Services are the barebones of feathers applications. For more info: https://docs.feathersjs.com/api/services.html

• tests - Where our tests lives. They are separated by service and can be splitted on smaller files.

• config - Global config files for our application read more on https://docs.feathersjs.com/api/configuration.html

• lib - Generated after typescript transpilation

• public - Contain resources for rendering html and configuration for server rendered pages

Docs

We have covered a basic usage of API on Postman: prodap-case.postman_collection.json For a full overview of how queries work on feathers, access https://docs.feathersjs.com/api/databases/querying.html