Nest Hackathon Starter

screenshot of Nest Hackathon Starter
nestjs
prisma

Nest Hackathon Starter

Hackathon starter project for NestJS. Includes Prisma, email verification, Passport-JWT authentication, Swagger and more

Overview

The Nest Hackathon Starter is a project that provides boilerplate code for creating APIs using Nest, a Node.js framework for building efficient and scalable server-side applications. It is designed to be used as a starting point in hackathons and includes common features such as sign up, JWT authentication, mail validation, model validation, and database access. It also offers customization options, Swagger API documentation, security techniques, and a logger.

Features

  • PostgreSQL with Prisma: The template includes PostgreSQL integration with Prisma, a tool for database access and migration.
  • JWT Authentication: Implements JWT authentication for secure user authentication.
  • Mail Verification: Provides email verification functionality for user account validation.
  • Mail Change: Allows users to change their email address.
  • Password Reset: Includes password reset functionality.
  • Request Validation: Implements request validation to ensure data integrity.
  • Customizable Mail Templates: Offers customizable mail templates for email notifications.
  • Swagger API Documentation: Generates API documentation using Swagger.

Installation

To install the Nest Hackathon Starter, follow these steps:

  1. Ensure that you have Node.js (>= 10.13.0, except for v13) installed on your system.
  2. Clone the repository by running git clone https://github.com/ahmetuysal/nest-hackathon-starter.git <YOUR_PROJECT_NAME> or create your own GitHub repository using this template.
  3. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
  4. Run yarn to install dependencies.

Summary

The Nest Hackathon Starter is a helpful boilerplate project for quickly creating APIs using the Nest framework. It offers essential features such as authentication, email verification, and password reset, along with customizable mail templates and thorough documentation. By providing a solid starting point, this project can save developers time when building server-side applications for hackathons or other projects.

nestjs
Nest

A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications with TypeScript/JavaScript.

prisma
Prisma

Prisma is a server-side library that helps developers read and write data to the database in an intuitive, efficient and safe way.

fullstack
Fullstack Boilerplates

A fullstack boilerplate provides a starter application that includes both frontend and backend. It should include database, auth, payments, user roles and other backend services to build a fully featured saas or webapps.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.