Skip to content

Awaik is a service uptime monitoring tool that periodically sends requests to services, awaits a response, and checks that they are awake (get it... awaik πŸ‘ˆπŸ‘ˆ)

License

Notifications You must be signed in to change notification settings

taylow/awaik-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Awaik logo - fat cat sleeping

Awaik - Don't hesitate; await the awake state!

Status GitHub Issues GitHub Pull Requests


This repository holds the frontend code for Awaik.

πŸ“ Table of Contents

🧐 About

Awaik is a service uptime monitoring tool that periodically sends requests to services, awaits a response, and checks that they are awake (get it... awaik πŸ‘ˆπŸ‘ˆ)

πŸ’Ύ Related Repositories

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

This project is currently developed on macOS, and so all instructions are written as such. They will be updated overtime, or if you want to update them sooner open a PR!

COMING SOON

πŸ”§ Running the tests

Running tests is as running the following:

make test

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

  • Configure the top-level parserOptions property like this:
export default {
  // other rules...
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    project: ['./tsconfig.json', './tsconfig.node.json'],
    tsconfigRootDir: __dirname,
  },
}
  • Replace plugin:@typescript-eslint/recommended to plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked
  • Optionally add plugin:@typescript-eslint/stylistic-type-checked
  • Install eslint-plugin-react and add plugin:react/recommended & plugin:react/jsx-runtime to the extends list

⛏️ Built Using

Backend:

  • GoΒ - Backend code

Infrastructure:

Frontend:

  • Vite - Frontend tooling
  • React - Web framework for frontend and internal web dashboards
  • TypeScript - Type safe language built on JavaScript

✍️ Authors

See also the list of contributors who participated in this project.

πŸŽ‰ Acknowledgements

  • Stack inspiration came from Monzo, as this is what they listed in a job opening, and I wanted to build something that used the same stack
  • Hat tip to Christian Selig for their apollo-backend repository; a fantastic example of a production-ready server written in Go
  • Thanks to my friend Connor O'Brien for helping me come up with a silly name for it, after all, you can't truly start a project until you know the domain exists and the SEO isn't already saturated, right? right??
  • Another thanks to my talented friend Dylan Thomas for the adorable cat logo!

About

Awaik is a service uptime monitoring tool that periodically sends requests to services, awaits a response, and checks that they are awake (get it... awaik πŸ‘ˆπŸ‘ˆ)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published