Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilia-kurganskii/family-tree-api
NestJS backend for FamilyTree
https://github.com/ilia-kurganskii/family-tree-api
graphql nestjs rest-api swagger typeorm
Last synced: 5 days ago
JSON representation
NestJS backend for FamilyTree
- Host: GitHub
- URL: https://github.com/ilia-kurganskii/family-tree-api
- Owner: ilia-kurganskii
- License: mit
- Created: 2021-01-31T11:02:36.000Z (about 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-08T01:24:18.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T04:14:36.565Z (2 months ago)
- Topics: graphql, nestjs, rest-api, swagger, typeorm
- Language: TypeScript
- Homepage:
- Size: 757 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.codacy.com/gh/elijah-kurganskiy/family-tree-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=elijah-kurganskiy/family-tree-api&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/elijah-kurganskiy/family-tree-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=elijah-kurganskiy/family-tree-api&utm_campaign=Badge_Coverage)
# Family Tree API
## Features
- :rocket: GraphQL [playground](https://github.com/prisma/graphql-playground)
- :rocket: Code-First [decorators](https://docs.nestjs.com/graphql/quick-start#code-first)
- :rocket: [Prisma](https://www.prisma.io/) for database modelling, migration and type-safe access (Postgres, MySQL & MongoDB)
- :rocket: JWT authentication [passport-jwt](https://github.com/mikenicholson/passport-jwt)
- :rocket: REST API docs [Swagger](https://swagger.io/)
- :rocket: Prettier and ESlint to static analyze a code
- :boat: Docker
## Overview
- [Family Tree API](#family-tree-api)
- [Features](#features)
- [Overview](#overview)
- [Development](#development)
- [1. Install Dependencies](#1-install-dependencies)
- [2. Install Docker](#2-install-docker)
- [3. Configure environment](#3-configure-environment)
- [4. Start NestJS Server](#4-start-nestjs-server)
- [Prisma migration](#prisma-migration)
## Development
### 1. Install Dependencies
Install [Nestjs CLI](https://docs.nestjs.com/cli/usages) to start and [generate CRUD resources](https://trilon.io/blog/introducing-cli-generators-crud-api-in-1-minute)
```bash
npm i -g @nestjs/cli
```
Install the dependencies for the Nest application:
```bash
npm install
# We need to generate Prisma client code to compile TS successfully
npm run prisma:generate
```
### 2. Install Docker
Use Docker and Docker-compose to develop the application in an isolated environment
[Link](https://docs.docker.com/engine/install/ubuntu/) to install instructions
### 3. Configure environment
We need to create `.env` file to configure server
```
cp .env.example .env
```
### 4. Start NestJS Server
```
npm run docker:dev
```
GraphQL Playground for the NestJS Server is available here: http://localhost:3000/graphql
Swagger for the NestJS Server is available here: http://localhost:3000/api
Prisma Studio for the NestJS Server is available here: http://localhost:5555
## Prisma migration
We use migrations to update the schema of the database according to our models
After each update of a model, we need to create a new migration
```bash
npm run docker:migrate:dev:create
```
**[⬆ back to top](#overview)**