Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leosuncin/nest-graphql-example
Example of GraphQL with Nest.js and TypeORM
https://github.com/leosuncin/nest-graphql-example
apollo-server conventional-commits example-project graphql jest nestjs pactum supertest typeorm typescript
Last synced: 21 days ago
JSON representation
Example of GraphQL with Nest.js and TypeORM
- Host: GitHub
- URL: https://github.com/leosuncin/nest-graphql-example
- Owner: leosuncin
- License: gpl-3.0
- Created: 2022-06-07T11:17:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-06-17T02:34:37.000Z (over 2 years ago)
- Last Synced: 2024-10-09T22:08:48.313Z (about 1 month ago)
- Topics: apollo-server, conventional-commits, example-project, graphql, jest, nestjs, pactum, supertest, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 321 KB
- Stars: 9
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎲 Nest.js GraphQL Example
[](https://github.com/leosuncin/nest-graphql-example/actions/workflows/mega-linter.yml)
[](https://github.com/leosuncin/nest-graphql-example/actions/workflows/ci.yml)
[](./LICENSE)
[](https://hits.dwyl.com/leosuncin/nest-graphql-example)
> An example of how to create and test a GraphQL Server with Nest.js and TypeORM
## Features
- GraphQL server with [Apollo](https://www.apollographql.com/)
- [Code first](https://docs.nestjs.com/graphql/quick-start#code-first) approach to build the schema
- [TypeORM](https://typeorm.io/) to connect with MySQL
- Unit tests and E2E tests
- [PNPM](https://pnpm.io/) for a fast and efficient installation
- Check code quality with [MegaLinter](https://megalinter.github.io/latest/)
- Check continuous integration with [github actions](.github/workflows/ci.yml)
- Run the necessary services with [docker compose](https://docs.docker.com/compose/)
## Run Locally
Clone the project
```bash
git clone https://github.com/leosuncin/nest-graphql-example.git
```
Go to the project directory
```bash
cd nest-graphql-example
```
Install dependencies
```bash
pnpm install
```
Create a `.env` from the example one and customize it with your [environment variables](#environment-variables)
```bash
cp .env.example .env
```
Start the services using Docker Compose
```bash
docker-compose up -d
```
Run migrations to create the DB schema
```bash
pnpm typeorm migration:run
```
Start the server
```bash
pnpm start:dev
```
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`MYSQL_DATABASE` the name of the database to connect in the MySQL instance **(required)**
`MYSQL_ROOT_PASSWORD` The password of the _root_ user to connect to the MySQL instance **(required)**
`DATABASE_URL` a connection string to the MySQL instance, example _mysql://root@localhost/example-db_ **(required)**
You can copy the example `.env` and edit the values
```bash
cp .env.example .env
```
## Running Tests
To run unit tests, run the following command:
```bash
pnpm test
```
To run e2e tests (the MySQL instance must be available), run the following command:
```bash
pnpm test:e2e
```
## Tech Stack
**Server:** Typescript, MySQL, Nest.js, TypeORM, Apollo
**Test:** Jest, SuperTest
**DevOps:** Docker Compose
## Author
👤 **Jaime Leonardo Suncin Cruz**
- Twitter: [@jl_suncin](https://twitter.com/jl_suncin)
- Github: [@leosuncin](https://github.com/leosuncin)
- LinkedIn: [@jaimesuncin](https://linkedin.com/in/jaimesuncin)
## Show your support
Give a ⭐️ if this project helped you!
## Related
Here are some more example projects with Nest.js
[](https://github.com/leosuncin/nest-auth-example)
[](https://github.com/leosuncin/nest-api-example)
[](https://github.com/leosuncin/nest-typeorm-custom-repository)
## License
Release under the terms of [GPL v3](./LICENSE)