/music-classes

Education Music Platform with Nest, Prisma and Docker (on development)

Primary LanguageTypeScriptMIT LicenseMIT

Education Music Platform

A Nest application to help beginners to learn how to play a instrument

The purpose of this project is to help beginners in music, which know little to nothing about a instrument, to learn how to play, with the possibility to learn different instruments and with lifetime access

Technologies used

  • NodeJS
  • NestJS
  • Prisma
  • Docker
  • PostgreSQL
  • JWT
  • Vitest + Supertest
  • Zod

Getting Started

Prerequisites

To run this project, it's necessary to prepare your environment, which means:

  1. Install NodeJS 16+ - https://nodejs.org/en
  2. Download and install Docker - https://www.docker.com/products/docker-desktop/

Installing

Cloning the Repository

$ git clone https://github.com/ArthurPMachado/plataforma-aulas-musica.git

$ cd plataforma-aulas-musica

Installing dependencies

$ pnpm i

Running Project

$ pnpm run start:dev

or

$ pnpm run start:prod

To run prod, is necessary to build first using:

$ pnpm run build

Running Tests

Unit tests (under development)

$ pnpm run test

or

E2E tests

$ pnpm run test:e2e

⚠️ DO NOT FORGET TO CREATE A .ENV FILE, OTHERWISE THE PROJECT WILL NOT WORK

Author

👤 Arthur Machado

Show your support

Give a ⭐️ if this project helped you!