Rizzeol/reach-now-task

A Backend NestJs service written in Typescript which consumes Github Search API and give result in specific format.

Project Details:

Description

This Project was scaffolded using Nest framework TypeScript starter repository. More project description to be added ...

Normal Build and Run

Install Node Modules

npm install

Start Server

npm run start:dev

Now you can call the api endpoint

http://localhost:3000/api?username=helloworld&languages=python,java

The above is Get API. The parameter details is as following:

username: search query for user / languages: programming language to filter search query

Build the Docker Image

docker build -t reach-now-task .

Start Docker Daemon client

Please start your Docker Daemon client in your machine. Make sure you have logined to docker client and have access to the docker resources.

Run the image

docker run -p 3000:3000 reach-now-task

Check in the Browser

http://localhost:3000/

Test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.