Skip to content

README.md

Latest commit

 

History

History
88 lines (67 loc) · 1.24 KB

README.md

File metadata and controls

88 lines (67 loc) · 1.24 KB

Task Server

This is a server-side application for a task management system. It is built using Node.js, Express, and MongoDB.

Getting Started

Prerequisites

  • Node.js
  • Express
  • MongoDB
  • Docker
  • Docker Compose

Installation & Run

Clone the repo:

git clone https://github.com/RiveraHan/task_server.git

Navigate to the project directory:

cd task-server

Install dependencies

npm install

Set the environment variables:

cp .env.example .env
# open .env and modify the environment variables (if needed)

Run the server

Commands

Running locally:

npm run dev

Running in production:

npm run start

Testing:

# run all tests
npm run test
# run all tests in watch mode
npm run test:watch
# run test coverage
npm run coverage

Docker:

# run docker container in development mode
npm run docker:dev
# run docker container in production mode
npm run docker:prod
# run all tests in a docker container
npm run docker:test

Linting:

# run ESLint
npm run lint
# fix ESLint errors
npm run lint:fix
# run prettier
npm run prettier
# fix prettier errors
npm run prettier:fix

The app should now be running on http://localhost:4000.