https://github.com/adekoreday/task-manager

A task management starter API built with Typescript MongoDB and NodeJS. Demonstrate how to write clean typed REST API with tests using mocha and chai
https://github.com/adekoreday/task-manager

jest-type jest-typescript mongodb mongoose mongoose-typescript nodejs typescript

Last synced: 2 days ago
JSON representation

A task management starter API built with Typescript MongoDB and NodeJS. Demonstrate how to write clean typed REST API with tests using mocha and chai

• Host: GitHub
• URL: https://github.com/adekoreday/task-manager
• Owner: Adekoreday
• Created: 2021-08-24T19:24:36.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-09T03:28:31.000Z (about 3 years ago)
• Last Synced: 2024-05-21T01:47:53.765Z (6 months ago)
• Topics: jest-type, jest-typescript, mongodb, mongoose, mongoose-typescript, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 10 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
### Readme

## post man documentation

https://documenter.getpostman.com/view/5907608/TzzEoaMi

### Getting Started

- Run mongodb locally using docker-compose

```

    docker-compose up

```

the url locally should be  

```

mongodb://localhost:27018

```

- Create the environment variable file. A sample of its content is provided in the .env.sample file committed to this Repo

#### Running in production mode

- update NODE_ENV=production in your .env file

- run the following

```

yarn install

yarn run start

```

### Watch Mode 

```

yarn install

yarn run watch

```

### test Mode

- update NODE_ENV=test in your .env file

```

yarn run test

```

Features that would have been implemented 

The following approach would have been implemented should there be time

- Email verification of regular user 

- Logging to sentry

- complete test for read, update and delete of task (already setup an example of how i'll do them in the task create test)

- introduce rate limit

- Searching and filtering

- add alias for types

- Add kubernetes deployment files