https://github.com/kalwabed/yotask-be

Nest.js application providing REST API for consumption. A backend for yotask-fe.
https://github.com/kalwabed/yotask-be

mongodb mongoose nestjs

Last synced: about 2 months ago
JSON representation

Nest.js application providing REST API for consumption. A backend for yotask-fe.

• Host: GitHub
• URL: https://github.com/kalwabed/yotask-be
• Owner: kalwabed
• Created: 2024-02-19T10:03:54.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-19T15:39:25.000Z (11 months ago)
• Last Synced: 2024-02-20T11:58:14.385Z (11 months ago)
• Topics: mongodb, mongoose, nestjs
• Language: TypeScript
• Homepage:
• Size: 71.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# YoTask Backend

This project is a Nest.js application providing REST API for consumption. A backend for [yotask-fe](https://github.com/kalwabed/yotask-fe).

## Tech Stack

- Nest.js

- Typescript

- MongoDB

## Getting Started

To get started running the project locally, please follow the steps below.

First, clone the repository.

```bash

git clone https://github.com/kalwabed/yotask-be.git

```

Then, install dependencies and fetch data to your local machine.

```bash

cd yotask-be

pnpm install

```

Copy the `.env.example` file to a new file with the name `.env`:

```bash

cp .env.example .env

```

Then, make sure you already have a MongoDB instance (cloud or locally) and fill in the connection URI appropriately:

```env

# .env

MONGO_URL=

PORT=

```

Finally, run the development server.

```bash

pnpm start:dev

```

Open [localhost:8000/docs](http://localhost:8000/docs) with your browser to see the Swagger.

## Deployment

For deployment, we can use services like AWS or Railway.

## Learn More

- https://nestjs.com