Baby food introduction API

This API is part of the Baby Food Introduction application, which aims to help technological parents keep track of the food introductions they make for their babies.

Motivation

I'm really forgetful, and food introduction in babies can be tricky. When you first start introducing food at around 6 months old, you need to do it in an orderly and spaced manner.

You need to introduce one food at one given week, and then in the next week you introduce another, and so on. The problem with food introduction arises when your babies have an allergy!

When an allergy happens, you need to backtrack the food introductions you have been doing one by one. You remove the latest one introduced and wait a week. If the baby is still not ok, you remove the previous one, and so on.

For this exact purpose, I created the Baby Food Introduction application, to help parents keep their babies food introductions in check and easily backtrackable in case of allergies!

Installation

$ yarn install

Running the app

⚠️ Important ⚠️

To first start with running the API, you need to copy .env.example to .env and fill in with correct values.

start, start:dev and start:debug need a database up and running, and for that, use the start:db command.

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# debug mode
$ yarn run start:debug 

# production mode
$ yarn run start:prod

Documentation

There's a Postman collection in the repo that allows to consume all the endpoints created. If there are new additions to the controllers of the API, please add them to this postman collection, so that other devs have an easier life!

Production

We are using Heroku to deploy the API and to provision the corresponding database. There's a production API currently deployed at https://baby-food-intro-api.herokuapp.com/api/v1.