Pager Frontend

Frontend client for the Pager project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

A universal notification system. The goal is to provide a framework for publishing and administering notifications.

The project focuses on simplifying integration and handling notifications. In other words; it should be profoundly simple to publish a notification from anywhere, and it should be profoundly simple to experience only the relevant notifications.

Built With

• Vue3
• ViteJS
• Axios

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

• For local development, the developer environment is required

Installation

1. Clone the repo

   git clone https://github.com/tuuturu/pager-frontend.git

2. Enter the repo folder

   cd pager-frontend

3. Install NPM packages

   npm install

Usage

1. Run the project

   make run

2. Open the URL

Roadmap

See the open projects for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Julius Pedersen - @deifyed@mastadon

Project Link: https://github.com/tuuturu/pager-frontend

Acknowledgements

• The Open Source community. Everything I build stands upon libraries and technologies made available by you