michaelhpet/fc-meals-api

A simple CRUD REST API for meals using PostgreSQL, Knex.js, and Objection.js in NestJS

FoodCourt Meals API

CRUD Operations for meals using PostgreSQL, Knex.js, and Objection.js in NestJS

Steps to run server

Clone this repository

git@github.com:michaelhpet/fc-meals-api.git
cd fc-meals-api

Install dependencies

npm install

Create .env file (reference .env.example)

cp .env.example .env

Fill-in variables in .env file

DATABASE_NAME=
DATABASE_USER=
DATABASE_PASSWORD=

Please make sure to have created a local postgres database with these credentials

Migrate and seed database

npm run migrate
npm run seed

Start the server

npm start

Check OpenAPI spec descriptions for available endpoints

open http://localhost:3000/docs

Authors

• Michael Peter