MohamedAlabasy / Nest.JS-Articles-System

The goal of the project is to create articles by users and comment or like them after they create an account for them in the application and confirm their account by email, every person who created an article, comment or like can only edit or delete it whenever he wants.

Nest.JS Articles System

Description:

The goal of the project is to create articles by users and comment or like them after they create an account for them in the application and confirm their account by email.
Every person who created an article, comment, or like can only edit or delete it whenever he wants.

To run this project

Step 1 : To use this project must install Node.js, Nest.Js and Mysql as database Then Download the source code

git clone https://github.com/MohamedAlabasy/Nest.JS-Articles-System.git

Step 2 : Enter the project file then install the package

npm i

Step 3 : Create a database called articles_system, then run the server on watch mode :

npm run start:dev

Step 4 : Open postman and import : API Collation You will find it in the project file.

To help you understand the project

Folder Structure

├── src
│   ├── config => `for app configuration`
│   │   ├── sendEmail.config.ts
│   │   ├── token.config.ts
│   │   └── typeorm.config.ts
│   │
│   │
│   ├── database
│   │   └── entities => `for database entities`
│   │         ├── articles.entity.ts
│   │         ├── comments.entity.ts
│   │         ├── email-verification.entity.ts
│   │         ├── forgot-password.entity.ts
│   │         ├── likes.entity.ts
│   │         └── users.entity.ts
│   │
│   │
│   ├── middleware
│   │   ├── check-tokens.middleware.ts => `for check tokens on all requests`
│   │   └── logger.middleware.middleware.ts => `for log URL, method and statute of requests`
│   │
│   │
│   ├── models
│   │   ├── articles => `for handel articles code`
│   │   │     ├── dto => `for handel data transfer object for articles`
│   │   │     ├── articles.controller.ts => `for handel articles functions and routes (endpoints)`
│   │   │     ├── articles.module.ts => `for handel articles Models`
│   │   │     └── articles.service.ts => `for handel articles database connection and query`
│   │   │
│   │   │── comments => `for handel comments code`
│   │   │     ├── dto
│   │   │     ├── articles.controller.ts
│   │   │     ├── articles.module.ts
│   │   │     └── articles.service.ts
│   │   │
│   │   │── email-verification => `for handel email-verification code`
│   │   │     ├── dto
│   │   │     ├── articles.module.ts
│   │   │     └── articles.service.ts
│   │   │
│   │   │── forgot-password => `for handel forgot-password code`
│   │   │     ├── dto
│   │   │     ├── articles.controller.ts
│   │   │     ├── articles.module.ts
│   │   │     └── articles.service.ts
│   │   │
│   │   │── likes => `for handel likes code`
│   │   │     ├── dto
│   │   │     ├── articles.controller.ts
│   │   │     ├── articles.module.ts
│   │   │     └── articles.service.ts
│   │   │
│   │   └── users => `for handel users code`
│   │         ├── dto
│   │         ├── articles.controller.ts
│   │         ├── articles.module.ts
│   │         └── articles.service.ts
│   │
│   │
│   ├── pipes => `for handel custom pipe`
│   │   ├── email-lower-case.pipe.ts
│   │   ├── hash-password.pipe.ts
│   │   └── register.pipe.ts
│   │
│   │
│   ├── utilities
│   │   ├── email
│   │   │   │── emailVerification.ts => `for send email message`
│   │   │   └── emailMessagesDesign.ts => `for email messages design ( HTML & CSS )`
│   │   │── common.ts => `for common variables`
│   │   └── get-id-from-token.ts => `to get id from token`
│   │
│   │
│   └── main.ts => `to run the server`
└──

DataBase ERD

After completing the registration as a new user, you must go to your email to confirm the email through the code sent to you

---

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run start:prod

Test

# unit tests
npm run test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov

---

Here are the Command that were used in the project, You will find it in the project file.