https://github.com/lukascivil/tasker

Tasker API is a nest-js example
https://github.com/lukascivil/tasker

example nestjs rest-api

Last synced: 10 months ago
JSON representation

Tasker API is a nest-js example

• Host: GitHub
• URL: https://github.com/lukascivil/tasker
• Owner: lukascivil
• Created: 2020-09-20T20:44:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-03T01:33:34.000Z (over 1 year ago)
• Last Synced: 2025-02-07T04:42:46.340Z (12 months ago)
• Topics: example, nestjs, rest-api
• Language: TypeScript
• Homepage:
• Size: 4.49 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  



Tasker-Server, a task registration application


![badge](https://action-badges.now.sh/lukascivil/tasker)

[![codecov](https://codecov.io/gh/lukascivil/tasker/branch/master/graph/badge.svg)](https://codecov.io/gh/lukascivil/tasker)

## Description

Tasker is an application for registering tasks. The server was created using Nestjs following the REST pattern. The front application that will use this app server will use the [react-admin](https://marmelab.com/react-admin/Readme.html) framework.

## Installation

### Installation

```bash

$ yarn

```

### DataBase

On windows you can download [xampp](https://www.apachefriends.org/) to up MySQL DB, its free application.

![image](https://user-images.githubusercontent.com/7409802/99200349-8164d480-2783-11eb-9815-426f1af7f73e.png)

On Linux you can install MySQL using apt

```bash

$ sudo apt update

$ sudo apt install mysql-server

```

### Running the DB

```bash

sudo systemctl start mysql

```

## Running the app

```bash

# development

$ yarn start:debug

# production mode

$ yarn start:prod

```

## Test

```bash

# unit tests

$ yarn test

# e2e tests

$ yarn test:e2e

```

## Open API Documentation

```bash

# Swagger Docs

open http://localhost:3000/api

```

![image](https://user-images.githubusercontent.com/7409802/99883901-fcf1d600-2c08-11eb-9497-7b0f87562e7d.png)

## Project Architecture Documentation

```bash

# Docs with compodoc

$ yarn compodoc

open http://localhost:8080/

```

![image](https://user-images.githubusercontent.com/7409802/99883854-b43a1d00-2c08-11eb-9e3d-0242c5098e2f.png)

## Health

```bash

# Health API with Terminus

open http://localhost:3000/health

```

## Running the client

Read the docs of Tasker client here: https://github.com/lukascivil/our-admin

### Plus

If you want to view the tables in the DBMS and the documents created, you can use a graphical tool to access.

[HeidiSQL](https://www.heidisql.com/) is a free and powerful client for MariaDB, MySQL, Microsoft SQL Server, PostgreSQL and SQLite.