https://github.com/lukascivil/react-admin-nestjs-example

CRUD example with react-admin, nestjs and postgres
https://github.com/lukascivil/react-admin-nestjs-example

admin-panel nestjs react react-admin rest-client

Last synced: 5 days ago
JSON representation

CRUD example with react-admin, nestjs and postgres

• Host: GitHub
• URL: https://github.com/lukascivil/react-admin-nestjs-example
• Owner: lukascivil
• Created: 2020-11-15T21:29:18.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-23T19:19:51.000Z (3 months ago)
• Last Synced: 2024-11-23T20:18:53.730Z (3 months ago)
• Topics: admin-panel, nestjs, react, react-admin, rest-client
• Language: TypeScript
• Homepage:
• Size: 28.6 MB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  

  



Tasker-Client, a task registration application

(CRUD example of React-Admin and RTK Query + nestjs + postgress)


## Description

Tasker is an application for registering tasks. The client side was created using [React-Admin](https://marmelab.com/react-admin/Readme.html) following the REST pattern on dataproviders. The backend application that will server the API was created using [nestjs](https://docs.nestjs.com/) framework with [postgresql](https://www.postgresql.org/). This is an example of a react-admin application and shows how powerful the tool is, and how it is possible to create CRUD systems with nestjs.

The example project follows the line of being a laboratory for study, therefore tests with [RTK Query](https://redux-toolkit.js.org/rtk-query/overview) are present as well.

This is a monorepo tha uses yarn workspaces to orchestrate it.

## Screenshot

![image](https://user-images.githubusercontent.com/7409802/123529179-4e44d500-d6c4-11eb-811b-f2b1406cb58b.png)

![GIF 15-11-2020 20-29-13](https://user-images.githubusercontent.com/7409802/99199957-5aa59e80-2781-11eb-9bd6-09e14f9c0981.gif)

## 1- Installation

```bash

$ yarn

```

## 2- Running the app (react admin client + nestjs server + postgres DB)

```bash

# Development

$ yarn start

```

## 3- Create first user with login and password

```bash

// You need a client to connect to postgres on 127.0.0.1:5432

// Its recommended to use https://www.heidisql.com/ but feel free to decide.

INSERT INTO "public"."user" ("id", "name", "email", "password") VALUES (1, 'admin', '[email protected]', "admin");

```

## Project (nestjs server) 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)

## Project (nestjs server) Health

```bash

# Health API with Terminus

open http://localhost:3000/health

```

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.