# smarthomeapi

> SmartHomeAPI is a RESTful API designed to manage smart home devices. Utilizing Hexagonal Architecture, it is built using technologies such as NestJS, MongoDB, TypeScript, and Docker.

Latest version **1.0.0** (published 2024-04-14) · ISC license · 3 weekly downloads

## Install

```sh
npm install smarthomeapi
pnpm add smarthomeapi
yarn add smarthomeapi
bun add smarthomeapi
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: no vulnerabilities; growing popularity.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-04-14 |
| First published | 2024-04-14 |
| Weekly downloads | 3 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | pardal275 |

## Links

- npm: https://www.npmjs.com/package/smarthomeapi
- npm.io page: https://npm.io/package/smarthomeapi

## Dependencies (6)

- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [mongoose](https://npm.io/package/mongoose.md) ^7.5.3
- [@nestjs/cli](https://npm.io/package/@nestjs/cli.md) ^10.2.0
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^10.2.6
- [@nestjs/mongoose](https://npm.io/package/@nestjs/mongoose.md) ^10.0.1
- [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^10.2.6

## Recent versions

- 1.0.0 (latest) — 2024-04-14

## README

# SmartHomeAPI

## Description
SmartHomeAPI is a RESTful API designed to manage smart home devices. Utilizing Hexagonal Architecture, it is built using technologies such as NestJS, MongoDB, TypeScript, and Docker.

## Features
- Add new smart home devices
- Retrieve a list of all smart home devices
- Track the status of each device

## Prerequisites
- Node.js
- Nest.js
- Typescript
- Docker
- MongoDB

## Installation

### Clone the repository
```bash
git clone git@github.com:GabrielFerraroDev/smartHomeAPI.git
```

### Install Dependencies
```bash
cd smartHomeAPI
npm install
```

### Set up Environment Variables
Copy the `.env.example` file to `.env.development` or `.env.production` and fill in the necessary environment variables.

### Run the Containers
```bash
docker-compose up -d
```
### Run the Application
To run the application in development mode:
```bash
npm run start:dev
```

To run the application in production mode:
```bash
npm run start:prod
```
### License
This project is licensed under the MIT License.

---
_Source: https://npm.io/package/smarthomeapi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._