https://github.com/maxkorop/vreal-soft-test-task-nodejs

Management API of uesrs and posts
https://github.com/maxkorop/vreal-soft-test-task-nodejs

nest node typescript

Last synced: 3 months ago
JSON representation

Management API of uesrs and posts

• Host: GitHub
• URL: https://github.com/maxkorop/vreal-soft-test-task-nodejs
• Owner: MaxKorop
• License: mit
• Created: 2024-06-06T07:56:43.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-11T10:47:19.000Z (7 months ago)
• Last Synced: 2024-09-29T01:41:05.655Z (3 months ago)
• Topics: nest, node, typescript
• Language: TypeScript
• Homepage: https://vreal-soft-test-task-nodejs.onrender.com/api/docs
• Size: 319 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Management API

## Deployment

The project is deployed on the [render.com] (https://render.com) service. [Deployed Project URL](https://vreal-soft-test-task-nodejs.onrender.com/api/docs)

This is a free instance, and free instances terminate after periods of inactivity, so initial requests may take a long time to process.

## Local launch

To run the project locally, you need to:

### Installation

In the project folder, run the following command

```bash

$ npm install

```

### Configuration

You need to create an `.env` file in the project folder. This project uses MongoDB as the database, so you need to start and connect to the mongodb server.

In the `.env` file, you need to create a `CONNECTION_STRING` variable and set your database connection string as the value of this variable. Its value should look like this

```.env

CONNECTION_STRING = ''

```

After that you need to set the JWT secret key in this file in `JWT_SECRET_KEY` variable.

So the final `.env` file should look like this:

```environment

CONNECTION_STRING = ''

JWT_SECRET_KEY = ''

```

### Run

You can run this project after the previous steps with the following command:

```bash

$ npm run start

```