https://github.com/vindecodex/vvillaluna-elearning

NestJS ELearning
https://github.com/vindecodex/vvillaluna-elearning

authentication authorization casl crud-api nestjs nestjs-backend typeorm typescript

Last synced: 10 days ago
JSON representation

NestJS ELearning

• Host: GitHub
• URL: https://github.com/vindecodex/vvillaluna-elearning
• Owner: vindecodex
• Created: 2022-10-24T01:21:16.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-10T08:20:36.000Z (about 2 years ago)
• Last Synced: 2024-12-30T07:52:23.293Z (12 days ago)
• Topics: authentication, authorization, casl, crud-api, nestjs, nestjs-backend, typeorm, typescript
• Language: TypeScript
• Homepage:
• Size: 786 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


E-Learning API



## Setup

##### Step 1

After clonning the project cd inside root directory of the project and copy `.env.sample` and named it to `.env`

```bash

cp .env.sample .env

```

for the **smtp** part of the environment variables, this project is using **[sendgrid](https://sendgrid.com/)**.

All of the fields will be provided when integrating using **[smtp relay](https://app.sendgrid.com/guide/integrate/langs/smtp)** on sendgrid account.

```

MAILER_HOST=smtp.sendgrid.net // default host

MAILER_USER=apikey // default user

MAILER_PASSWORD=

MAILER_FROM=

```

##### Step 2

Run docker compose with `~$: docker compose up`.

###### Alternatively running without docker

Requirements:

- Redis v6+

- Postgres v14+

- node v14+

Running the API server:

- npm i

- npm run start:dev

## Testing

#### Unit Testing

Run unit test:

```bash

npm t

```

Run unit test with coverage:

```bash

npm run test:cov

```

#### E2E Testing

```bash

npm run test:e2e

# By Module (subject | course | module | content | enrollment | user)

npm run test:e2e -- course

```

## API Documentation

While running the API, navigate to http://localhost:3000/docs