Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.64 KB

README.md

File metadata and controls

67 lines (46 loc) · 1.64 KB
Raw

🤖 ChatGPT Study With Me AI BE

📚 Back-end repository for ChatGPT Study With Me AI.

🚀 Getting Started

To get started with this project, you should have Node.js and npm installed on your machine. Clone the repository and run npm install to install the necessary dependencies.

npm install
npm run start

💻 Available Scripts

In the project directory, you can run:

npm run prebuild Cleans the dist directory before building the application.

npm run build Builds the application.

npm run format Formats the code using Prettier.

npm run start Starts the application in production mode.

npm run start:dev Starts the application in development mode with automatic reloading.

npm run start:debug Starts the application in development mode with debugging enabled.

npm run start:prod Starts the built application in production mode.

npm run lint Lints the code using ESLint and automatically fixes issues.

npm run test Runs the test suite using Jest.

npm run test:watch Runs the test suite in watch mode using Jest.

npm run test:cov Runs the test suite with coverage using Jest.

npm run test:debug Runs the test suite with debugging enabled using Jest.

npm run test:e2e Runs the end-to-end test suite using Jest.

📁 Folder Structure

The code is organized into the following directories:

src/auth This directory contains the NestJS module for authentication.

src/user This directory contains the NestJS module for retrieving user information.

src/email.ts This file contains the module for validating email addresses.

src/config This directory contains configuration information for the application.