1.0.0 • Published 2 years ago
smarthomeapi v1.0.0
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
git clone git@github.com:GabrielFerraroDev/smartHomeAPI.gitInstall Dependencies
cd smartHomeAPI
npm installSet up Environment Variables
Copy the .env.example file to .env.development or .env.production and fill in the necessary environment variables.
Run the Containers
docker-compose up -dRun the Application
To run the application in development mode:
npm run start:devTo run the application in production mode:
npm run start:prodLicense
This project is licensed under the MIT License.
1.0.0
2 years ago