Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laurabeatris/typeorm-relations

practicing many to many relationships with typeorm, postgres and express
https://github.com/laurabeatris/typeorm-relations

backend express jest nodejs postgres rest typeorm typescript

Last synced: 18 days ago
JSON representation

practicing many to many relationships with typeorm, postgres and express

Host: GitHub
URL: https://github.com/laurabeatris/typeorm-relations
Owner: LauraBeatris
Created: 2020-08-24T10:45:01.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2023-01-24T03:42:24.000Z (almost 2 years ago)
Last Synced: 2024-10-11T10:48:15.064Z (about 1 month ago)
Topics: backend, express, jest, nodejs, postgres, rest, typeorm, typescript
Language: TypeScript
Homepage:
Size: 355 KB
Stars: 21
Watchers: 3
Forks: 5
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        


   



# TypeORM Relationships

> Learn how to perform relationships in TypeORM

> [![Run in Insomnia}](https://insomnia.rest/images/run.svg)](https://insomnia.rest/run/?label=Hotseat%20API&uri=https%3A%2F%2Fraw.githubusercontent.com%2FLauraBeatris%2Ftypeorm-relations%2Fmaster%2F.github%2Ftypeorm_relations.json)

[![Author](https://img.shields.io/badge/author-LauraBeatris-ED341F?style=flat-square)](https://github.com/LauraBeatris)

[![Languages](https://img.shields.io/github/languages/count/LauraBeatris/typeorm-relations?color=%23ED341F&style=flat-square)](#)

[![Stars](https://img.shields.io/github/stars/LauraBeatris/typeorm-relations?color=ED341F&style=flat-square)](https://github.com/LauraBeatris/typeorm-relations/stargazers)

[![Forks](https://img.shields.io/github/forks/LauraBeatris/typeorm-relations?color=%23ED341F&style=flat-square)](https://github.com/LauraBeatris/typeorm-relations/network/members)

[![Contributors](https://img.shields.io/github/contributors/LauraBeatris/typeorm-relations?color=ED341F&style=flat-square)](https://github.com/LauraBeatris/typeorm-relations/graphs/contributors)

# :pushpin: Table of Contents

* [Features](#rocket-features)

* [Database Model](#clipboard-features)

* [Learning Sources](#orange_book-learning-sources)

* [Installation](#construction_worker-installation)

* [Getting Started](#runner-getting-started)

* [FAQ](#postbox-faq)

* [Found a bug? Missing a specific feature?](#bug-issues)

* [Contributing](#tada-contributing)

* [License](#closed_book-license)

# :rocket: Features

* 🛍  Store orders, products and customers

* 📔  Store students, classes and teachers

# :clipboard: Database Model

In order to understand the relationships, I've created the following database models:



   





   



# :orange_book: Learning Sources

- [Relations in TypeORM](https://orkhan.gitbook.io/typeorm/docs/relations)

- [What are Many To Many Relations](https://typeorm.io/#/many-to-many-relations/what-are-many-to-many-relations)

- [Many to Many Entities in TypeORM](https://www.youtube.com/watch?v=RH_es0awU_A)

- [Saving Many to Many Relations with only one save call](https://typeorm.io/#/relations/cascades)

# :construction_worker: Installation

**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**

```

git clone https://github.com/LauraBeatris/typeorm-relations.git

```

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

```

git clone [email protected]:LauraBeatris/typeorm-relations.git

```

**Install dependencies**

```

yarn install

```

Or

```

npm install

```

Create your enviroment variables based on the examples of ```.env.example```

```

cp .env.example .env

```

After copying the examples, make sure to fill the variables with new values.

**Setup a database**

Install [Postgres](https://www.postgresql.org/) to create a database or if you have [Docker](https://www.docker.com/) in your machine, fill the environment values related to database configurations and then run the following commands in order to create a Postgres container.

```docker-compose up```

# :runner: Getting Started

Run the transactions in order to configure the database schema

```yarn typeorm migration:run```

Run the following command in order to start the application in a development environment:

```yarn dev:server```

# :postbox: Faq

**Question:** What are the tecnologies used in this project?

**Answer:** The tecnologies used in this project are [NodeJS](https://nodejs.org/en/) + [Express Framework](http://expressjs.com/en/) to handle the server and [TypeORM](https://typeorm.io/#/)

# :bug: Issues

Feel free to **file a new issue** with a respective title and description on the the [TypeORM Relations](https://github.com/LauraBeatris/typeorm-relations/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/LauraBeatris/typeorm-relations/blob/master/CONTRIBUTING.md) to find out about the coding standards.

# :tada: Contributing

Check out the [contributing](https://github.com/LauraBeatris/typeorm-relations/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.

# :closed_book: License

Released in 2020.

This project is under the [MIT license](https://github.com/LauraBeatris/typeorm-relations/master/LICENSE).

Made with love by [Laura Beatris](https://github.com/LauraBeatris) 💜🚀