Tasks Manager

This repository contains a sample project of a Task Manager API.

Getting started

# install dependencies
npm install

# create .env file from example (don't forget to edit it)
cp .env.example .env

# build project
npm run build

# run project
npm start

Technologies

Name	Description
NodeJS	JavaScript runtime environment that executes JS code outside a web browser
Express	Web application framework for Node.js
TypeORM	ORM for TypeScript and JavaScript that supports SQL
Tsyringe	lightweight dependency injection container for TypeScript
Overnight	TypeScript decorators for methods meant to call Express routes
Jest	Testing library for JavaScript
TypeScript	JavaScript compiler/type checker that boosts JavaScript productivity

Running

List of all the available scripts:

NPM Script	Description
serve	Runs node on dist/index.js which is the app entry point
start	Does the same as 'npm run serve'. Can be invoked without the run param
watch	Runs app with nodemon so the process restarts if it crashes or a file changes
build	Compiles all source .ts files to .js files in the dist folder
watch-build	Same as build but continuously watches .ts files and re-compiles when needed
test	Runs tests using Jest test runner
t	Same as npm run test. Can be invoked without the run param

Docker

To run with docker, follow the commands:

# first create the .env file
cp .env.example .env

# edit the values with the ones in docker-compose.yml
nano .env

# then start docker-compose
docker-compose up

Documentation

For detailed documentation of the API, run the server and go to /docs page.

You can also check the swagger.yml directly.

Versioning

We use SemVer for versioning.