Regat is an integration system which integrates 3 external systems. The 3 external systems are Opsgenie, AWX, and GitHub. With the help of Regat, those 3 external systems can be connected to each other.
Regat uses Node.js as runtime environment and NestJS as framework.
To install regat, run the command below.
$ npm install
Regat use sequelize to connect to PostgreSQL database. Here are the manual for sequelize. To change anything in the database we can use sequelize migration. To make a sequelize migration file we can use the command below.
npx sequelize-cli migration:generate --name <migration-file-name>
This command will generate a file under src/database/migrations
After the file is created, we can edit the file to make changes to the database.
Then to execute the changes we can run this command in the project root.
npx sequelize-cli dg:migrate
To undo the migration use this command.
npx sequelize-cli dg:migrate:undo
All of these command can also be executed in Regat's running container in production.
Just make sure the directory is /dist
.
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
These are the commands to run some tests. Currently, there is no test to run.
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
Regat uses GitHub Action to create a Docker Image and push it to hub.docker.com repository when a new release is published. To make a new release, here are the steps:
<> Code
tab, go to a Release section, and there will be a + n release
button. Click the button.Draft a new release
button and click on it.Publish release
button to publish the release.Actions
tab in the repository.