Athon API

---

Requires

• NodeJS
• TypeScript
• Docker

To run Developer environment

• Up database docker-composer up
• Up Dev npm run dev
• Test dist npm start

Environment Variables

On Development environment need to create a file .env with then variables:

# VARIABLES OF ENVIROMENT
# ENVIRONMENT
NODE_ENV=

# SERVER CONFIGS
PORT=
HOST=

# TIMEZONE
TIMEZONE=

# DATA BASE CONFIG CONNECTIONS RELATIONAL
DB_CLIENT=
DB_HOST=
DB_NAME=
DB_USER=
DB_PASSWORD=
DB_PORT=

# CACHE CONFIGS
CACHE_CONFIG=
CACHE_TIME=
REDISHOST=
REDISPORT=

# SECURITY CONFIGS
SALT_ROUNDS=
STORAGE_TYPE=
ENABLE_HTTPS=
CERT_FILE=
KEY_FILE=

# AWS CONFIGS
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
AWS_BUCKET=

AUTHSECRET=

On test environment create .env.testing:

# VARIABLES OF ENVIROMENT
# ENVIRONMENT
NODE_ENV=

# SERVER CONFIGS
PORT=
HOST=

# TIMEZONE
TIMEZONE=

# DATA BASE CONFIG CONNECTIONS RELATIONAL
# USE SQLITE3
DB_CLIENT=
DB_FILENAME=

# DATA BASE CONFIG CONNECTIONS NO RELATIONAL
DBNR_PREFIX=
DBNR_USER=
DBNR_PASSWORD=
DBNR_HOST=
DBNR_PORT=
DBNR_DATABASE=

# CACHE CONFIGS
REDISHOST=
REDISPORT=

# SECURITY CONFIGS
SALT_ROUNDS=
ENABLE_HTTPS=
AUTHSECRET=

To use Https in Dev

To use https or ssl in the development environment is necessary to create a directory ssl with the tree:

certs
├── cert.pem
└── key.pem

the directory must contain in root:

• server.csr file;
• server.key file;
• cert directory;
  • server.crt file;

To generate self-signed certificate is suitable for the development environment. To generate the certificate files and openssl must be installed on the computer.
First generate a private key:

openssl genrsa -des3 -out server.key 1024

this command need to type a private phrase

Next step generate file.csr use this command

openssl req -new -key server.key -out old_server.csr

Answer all questions this step will request your private phrase

Last step generate file.crt use this command;

openssl x509 -req -days 365 -in old_server.csr -signkey server.key -out server.crt

To generate this file it is necessary to have generated the two previous files

to configure the application for https work's, fill in the following environment variables in the .env file

ENABLE_HTTPS=#Set value 'true' falue defaut is 'false'
CERT=#path for file.crt
KEY=#path for file.key

End-Points

LOGIN ON APLLICATION AND GENERATE TOKEN:

• Method: POST
• security: Open
• url: "/signin"
• Params:
  • email: "String, Required"
  • password: "String, Required"