esron / systranca-server

RESTful API server for a home automation controller server built in Express

SysTranca Server Project

This project was born when I came too early at my work building. We are a small startup on Vale do São Francisco, Brazil.

The objective of this project is provide an API with authentication and authorization for users to login into a home automation server that can, for now, open a electronic lock.

Instructions

This project uses MongoDB as database through the Mongoose library.

Install the dependencies:

npm install

Copy the .env.example file to .env:

cp .env.example .env

Update the variables to correspond your environment.

Generate the RSA keys:

npm run key:generate

or

node keys.js

---

Docker SetUp

You will also need a MongoDb instance and a MQTT broker.

This project comes with a docker-compose.ym file to help you deploy that locally, just:

docker-compose up

If you see this error when to execute node container:

Internal watch failed: ENOSPC: System limit for number of file watchers reached, watch '/home/node/app/README.md'

execute this to fix it:

sudo sysctl fs.inotify.max_user_watches=582222 && sudo sysctl -p

Create the super user

docker-compose exec app node initDatabase.js

This project doesn't have a front-end, yet.

systranca-server's Issues

The initDatabase script creates another user when there is already a user on the DB

When you run node initDatabase.js, the script always creates a new user.

The actual behavior was to create the admin user. So, if there is a user that have an email [email protected], the script should not create a new user.

Update Mongoose to version 6.x

Following this docs

Implement Tests

The controllers are getting bigger, that are already a lot of routes. It's time to invest in some TDD.

I like Jest, but everybody is free to suggest the test framework they like the most.

Token issuing logic

Implement the jwt token issuing logic.

Associate a token with a user.

WIP: Administration panel

An simple listing of the users and their phones.

An action button for blocking and unblocking a user.

Pin code validation

A request to activate a device, such as opening a door, should receive the user pin code as a form of security manner. If the request pin code does not match the user pin code the response should be a 403 HTTP response.

Update the docs

Add,

docker-compose up

and

docker-compose exec  node node initDatabase.js 

instead of node initDatabase.js

And port will be opened on localhost:3000 if all okay.

The localization configuration is not in accord with the layout

There is a select in the top right of the app main screen where you can select the idiom of the application.

There is already the portuguese and the english localization file.

The idioms that are not translated yet should not appear in the select.

The label of the select should be more informative.