Task App Server

This is a Node.js server project for a tasks application, built with TypeScript and MongoDB, following the Hexagonal architecture pattern.

Overview
Getting Started
- Prerequisites
- Installation
Usage
Contributing
License

Overview

The Task App Server is a backend application that provides the core functionality for managing tasks. It is built with Node.js and TypeScript, using MongoDB as the database to store and retrieve task data. The architecture of this server follows the Hexagonal architecture pattern, which promotes separation of concerns and maintainability.

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

Node.js installed (v14.0.0 or higher)
npm (Node Package Manager) installed
MongoDB server running (you can use a local or remote MongoDB instance)
TypeScript installed globally (npm install -g typescript)

Installation

Clone this repository:

git clone https://github.com/J4ASDev/tasks-app-node-ts-mongodb.git

Change into the project directory:
```
tasks-app-node-ts-mongodb
```
Install project dependencies:
```
npm install
```
Create a .env file in the root of the project and configure your MongoDB connection URL and other environment variables as needed:
```
 PORT=9000

 MONGO_URI=mongodb+srv://<username>:<password>@cluster0.ycel4.mongodb.net
 MONGO_DB_NAME=dbname
```
Compile TypeScript code:
```
npm run build
```
Start the server:
```
npm start
```

Usage

The server will be running at http://localhost:9000 by default. You can use tools like Postman or cURL to interact with the API endpoints. Please refer to the API Documentation section for detailed information on available endpoints and their usage.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow our Contributing Guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

J4ASDev/tasks-app-node-ts-mongodb