Skip to content

dzgierski19/AnimalsAPI

Repository files navigation

Animals

Create an app which allows you to perform a set of actions on animals. You can add, edit and retrieve animal records.

Objectives

  • Create an endpoint: /animals

GET should return all animals previously send to the app

POST should post list of animals to database

  • Create an endpoint: /animals/:id

GET should return an animal by id

PUT should update animal info

DELETE should delete animal from database

  • Create an endpoint: /animals/type/:type

POST should post a list of animals of a specific type

Technologies

Project is created with:

  • Node.js
  • NestJs
  • Express.js
  • TypeScript
  • Zod

Setup

To run this project, install it locally using npm:

# Clone the project
$ git clone https://github.com/dzgierski19/AnimalsAPI.git

# Go to the project directory
$ cd ANIMALS-API

# Install dependencies
$ npm install

# Start the server
$ npm run start

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

# migrations
$ npm run migrations

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published