ahmadfsalameh / notify

Notify is an issue tracker/reporting system where you and your team can collaborate on managing apps. Also, you can track your application Javascript errors using the API.

Notify - Issue Tracker

Notify is an issue tracker/reporting system where you and your team can collaborate on managing apps.


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • Settings
3. Usage
4. Contributing
5. Contact
6. Acknowledgments

About The Project

Issues tracking software is essential for managing businesses, but it's not usually tailored for developers and lacks some important functionalities. I know that this project isn't the most features-packed one, but you should give it a try.

Here's why:

• Just like a normal issues tracking software you can create teams and easily assign issues to different team members.
• You can connect your application to your account using a script then anytime an error popup to one of your users a new ticket will be created.
• It's free, open-source, and has an amazing user experience.

Other features will be useful to have, and guess what? I will be constantly adding new features all the time. also if you want to contribute to this project here is how.

(back to top)

Built With

• Node.js
• MongoDB
• Express
• React.js

(back to top)

Getting Started

Let me guide you through installing, setting up the project and getting it up and running on your local machine.

Installation

1. Clone the repo

   git clone https://github.com/ahmadfsalameh/notify.git

2. Install NPM packages (For both - Server & Client)

   npm install

Settings

1. In the server folder create .env file with the following code:

   database = DATABASE_CONNECTION_URL;
   jwtSecret = JWT_SECRET;
   sendgrid_api = API_KEY (Optional);
   email = SENDER_EMAIL;

   Please fill in the correct values. For more information about SendGrid click here.

2. In server folder/configs.js change the the path to your front-end if needed (Used in sent emails).

3. In client folder/src/configs.js change the path to your back-end.

   And you're ready 😀! Just run npm start in the client folder and run node index.js in the server folder.

(back to top)

Usage

Here is how you can connect your application to your issues to track your application errors in real-time.

On any page in your application or index.html if it is a single page application (React, Vue, etc) insert the following Javascript code:

<script>
  window.onerror = function (msg, url, lineNo, columnNo, err) {
    fetch("https://notify-issue-tracker.herokuapp.com/api/bugs", {
      method: "POST",
      body: JSON.stringify({
        apiKey: "YOUR_API_KEY",
        bug: {
          message: msg,
          error: JSON.stringify(err.stack),
        },
      }),
      headers: {
        "content-type": "application/json",
      },
    });
  };
</script>

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Ahmad Salameh - [e-mail]

(back to top)

Acknowledgments

Some of the amazing libraries that I've used in this project.

• DiceBear
• React Beautiful DND
• Font Awesome
• React Icons

(back to top)