API monitoring application

nou is an open-source monitoring platform designed to periodically provide insights into the health of websites and APIs. Utilize the nou UI to easily manage monitors, allowing you to observe your applications' uptime and receive timely notifications in the event of any failures.

⚠️ This repo only contains de source code of the application's server-side

• About nou
• Table of contents
• Build with
• Features
• Get started
  • Requirements
  • Installation and usage
  • Architecture
  • Roadmap
    • Version 0.1.0 (Upcoming release)
    • Future plans
• Contributing

• Fastify
• TypeScript
• Kysely
• PostgreSQL

• Monitor managment

⚠️ Other features are being implemented. See the roadmap.

• Node (20.10.0 or later)
• pnpm (8.6.3 or later)
• Docker

1. Clone this repo

$ git clone [email protected]:luscalima/nou.git # ssh

2. Install the dependencies

$ pnpm install

3. Start the required services (database etc.)

$ docker compose up -d

4. Run the migrations

$ pnpm migrate:latest

5. Start the application

$ pnpm dev

This project implements a more simplified architecture in the MSC (Model, Service, Controller) format. The following bullets explain each of these layers in more non-technical detail:

• The model layer is responsible for representing data and defining the business domain. The components that compose this layer are:
  • Models. Classes that define the form and nature of data.
  • Repositories. Abstractions that define the signature of methods that manipulate data defined by models.
  • Providers: Concrete implementations of repositories with a specific technology.
• The service layer is responsible for handling the business logic. The component that compose this layer is:
  • Services. Classes that expose methods to manipulate rules and handle business errors.
• The controller layer is responsible for handling API requests and resposes. The component that compose this layer is:
  • Controllers. Classes that expose static methods that handle things related to the HTTP protocol and validate input data and parameters.

• Monitor management:
  • CRUD operations.
• Contact management:
  • CRUD operations.
  • Linking a contact to a monitor.
• Monitoring
  • Script to run cronjobs based on parameters.
  • Service for cronjobs handling.
• User interface:
  • Monitor management.
  • Contact management.
• Alert for contacts:
  • Email sending.

• Automation with CI/CD.
• Community feedback.

1. Fork the repository
2. Create a new branch (feature branch method):

$ git checkout -b feature/new-feature

3. Make your changes and commit them.
4. Push to the branch:

$ git push origin feature/new-feature

5. Submit a pull request.