Simple Cards API

A simple consumable API for creating an anki clone

About

• Built with nest.js and REST endpoint
• quickstart

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

Nest CLI

Use nest cli to help setup nestjs projects and create modules, etc

# install nest cli 
$ npm i -g @nestjs/cli@latest

API Routes

Root URL: localhost:8000 or https://simple-cards-api.vercel.app/

Decks

/decks endpoint will return the user's decks where they can store a limit of 25 cards.

URL	METHOD	PARAMS	DETAILS	RESPONSES
/decks	GET
/decks	POST
/decks/:id	DELETE
/decks/:id	PUT

Card

/card endpoint will return the user's card where they can store a limit of 25 cards.

URL	METHOD	PARAMS	DETAILS	RESPONSES
/card/:id	GET
/card	POST
/card/:id	DELETE
/card/:id	PUT

Resources

• nest.js crash course 7 episodes
• deckofcards api