This project is a small service built with Nest.js dedicated to handling alerts, sectors, and other data for the Protezione Civile Nazionale alert systems.
Follow these instructions to set up the project on your local machine for development and testing purposes.
- Clone the repository to your local machine:
git clone https://github.com/alertconnect/alert-api.git - Install dependencies:
yarn install - Start the application in development:
yarn start:dev - Visit
http://localhost:3000in your browser to use the application.
- Nest.js - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
After releasing a new version, you need to push the new version to the registry.
Access to the registry is required.
$ docker login registry.gitlab.com
$ docker build -t registry.gitlab.com/alertconnect/alert-api:<VERSION> .
$ docker push registry.gitlab.com/alertconnect/alert-api:<VERSION>Contributions are welcome! If you want to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch (git checkout -b feature/your-feature).
- Make your changes.
- Commit your changes (git commit -am 'Add new feature').
- Push to the branch (git push origin feature/your-feature).
- Create a new Pull Request.
| code | description | default value |
|---|---|---|
| APP_PORT | App port | 8080 |
| DATABASE_URL | Database Host | localhost |
| API_KEY | Auth token | |
| REDIS_HOST | Redis Host | |
| REDIS_PORT | Redis Port | 6385 |
| REDIS_USERNAME | Redis Username | default |
| REDIS_PASSWORD | Redis Password | |
| LOGS_TOKEN | Logs token |
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE file for details