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

https://github.com/alexdevzz/nest-posts-graphql

This project is a very simplified API to exemplify the use of GraphQL as a communication layer on the NestJS framework, also using SQLite as a database and TypeORM for object-relational mapping.
https://github.com/alexdevzz/nest-posts-graphql

apollographql class-validator dto entity git graphql nestjs node posts repository sqlite typeorm typescript

Last synced: 6 months ago
JSON representation

This project is a very simplified API to exemplify the use of GraphQL as a communication layer on the NestJS framework, also using SQLite as a database and TypeORM for object-relational mapping.

Awesome Lists containing this project

README

          


Nest Logo
GraphQL Logo

#

Posts Backend API



















## 📋 Description

This project is a very simplified API to exemplify the use of GraphQL as a communication layer on the NestJS framework, also using SQLite as a database, TypeORM for object-relational mapping, and it has data validation through class-validator and DTOs (Data Transfer Objects).

## 🚀 Features
- **Node**: v20.17.0
- **npm**: v10.8.2
- **NestJS**: Progressive backend framework for Node.js
- **GraphQL**: Query language for APIs
- **SQLite3**: Embedded relational database
- **TypeORM**: ORM for TypeScript and JavaScript
- **class-validator**: Class and decorator validation
- **DTOs**: Data transfer pattern
- **TypeScript**: JavaScript superset type
- **ESLint**: Code linter for Javascript/Typescript
- **Prettier**: Open-source formatter
- works perfectly with any frontend client
- NestJs best practices through the use of DTOs (Data Transfer Objects), Resolvers, Entities, Modules, Services, and more
- Easy to use

## ⚙️ Install
1. Before continuing with the installation process you must have `node` installed on your operating system. If you do not have them, install it.

2. Clone this repository:
```bash
git clone https://github.com/alexdevzz/nest-posts-graphql.git
```
3. Install dependencies:
```bash
npm install
```
4. Run in development mode:
```bash
npm run start:dev
```

## 📝 Resources

Check out a few resources that may come in handy when working with NestJS:

- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
- To stay in the loop and get updates, follow me on [X](https://x.com/alexdevzz) and [LinkedIn](https://www.linkedin.com/in/alexdevzz/).

## 📣 Stay in touch

- LinkedIn - [alexdevzz](https://www.linkedin.com/in/alexdevzz/)
- Gmail - [alexdev.workenv@gmail.com](mailto:alexdev.workenv@gmail.com)
- X - [@alexdevzz](https://x.com/alexdevzz)
- Telegram - [@alexdev_00](https://t.me/alexdev_00)
- Instagram - [@is.ale_00](https://www.instagram.com/is.ale_00/)


## 🤝 Contributions

1. Fork the project
2. Create a branch (git checkout -b feature/new-feature)
3. Commit your changes (git commit -am 'Add new feature')
4. Push to the branch (git push origin feature/new-feature)
5. Open a Pull Request

Contributions are welcome! If you find any bugs or have any suggestions for improving the module, please feel free to open an issue or submit a pull request.

## 📄 License

This project is licensed under the MIT License. See the LICENSE file for details.