23 lines (19 loc) · 1.48 KB

Project Overview

This project is an application that provides an abstraction for my website to fetch data for the reading-list.

Stack overview

Written in TypeScript
Project is structured based on Clean Architecture by Uncle Bob
Uses jest and supertest for tests
Husky is used to ensure eslint and commitlint is run before each commit
Uses conventional commit for commit lint rule

Run Project Locally

git clone {this repo}
npm install or yarn
npm run dev
visit localhost:9000/api-docs

Environment Variables

Key	Value	Note
DEPLOYMENT_ENV	String indicates enviornment	Required
CONTENTFUL_SPACE_ID	contentful space id	Required
CONTNETFUL_ACCESS_TOKEN	contentful access token	Required