sophiabrandt / tdd-otp-chicago

Node.js/TypeScript application built with TDD (Chicago style)

TDD OTP Chicago

Node.js/TypeScript application built with TDD (Chicago style)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Code from the Udemy course: Building APIs doing TDD in Node and Typescript (and Jest) by Josep Mir.

Image by Muzammil Soorma

(back to top)

Built With

• Node.js
• TypeScript
• Jest

(back to top)

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

You'll need Node.js, Docker and docker compose.

All commands are tested with pnpm. If you want to use npm or yarn, you'll need to replace the necessary references.

Installation

1. Clone the repo

   git clone https://github.com/sophiabrandt/tdd-otp-chicago.git

2. Install NPM packages (via pnpm)

   pnpm install

3. copy env.example to .env (or rename file):

   cp env.example .env

4. Run Makefile:

   make docker
   make dev

(back to top)

Usage

make test

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

This is not an open-source project, but you are free to contribute if you like.

(back to top)

License

No license. The original code can be found here.

(back to top)

Contact

Twitter: @hisophiabrandt

Project Link: https://github.com/sophiabrandt/tdd-otp-chicago

(back to top)

Acknowledgments

• Josep Mir

(back to top)