Skip to content

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.

License

Notifications You must be signed in to change notification settings

alexdevzz/nest-posts-graphql

Repository files navigation

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:

    git clone https://github.com/alexdevzz/nest-posts-graphql.git
  3. Install dependencies:

    npm install
  4. Run in development mode:

    npm run start:dev

📝 Resources

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

  • Visit the NestJS Documentation to learn more about the framework.
  • Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • To stay in the loop and get updates, follow me on X and LinkedIn.

📣 Stay in touch

🤝 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.

About

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.

Topics

Resources

License

Stars

Watchers

Forks