MFINS

My Freakin' Internal Noticeboard Scrapper
Website · Request Feature / Report Bug

Table of Contents

• About The Project
  • Supports
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contact
  • Maintainer(s)
  • creators(s)
• Additional documentation

About The Project

This a microservice designed to send notceboard messages for the internal noticeboard to Naarad (NTFY). It uses the SSO token and jsessionid to access the noticeboard present in the erp. It checks for a new message every 2 minutes.

(back to top)

Getting Started

To set up a local instance of the application, follow the steps below.

Prerequisites

The following dependencies are required to be installed for the project to function properly:

• go

(back to top)

Installation

Now that the environment has been set up and configured to properly compile and run the project, the next step is to install and configure the project locally on your system.

1. Clone the repository

   git clone https://github.com/metakgp/mfins.git

2. Change directory to the folder

   cd ./mfins

3. Copy the .env.example to .env file

   cp .env.example .env

4. Fill the .env files with your erp credentials

5. Create lastmsg.json and add {} in it

     touch lastmsg.json && echo {} > lastmsg.json

6. Create erpcreds.json and add roll_number, password, answers

7. Create a google OAuth client secret and client id and add it to client_secret.json

8. Execute the script

    go run ./mfins

(back to top)

Usage

Use this space to show useful examples of how this project can be used. Additional screenshots, code examples and demos work well in this space.

(back to top)

Contact

📫 Metakgp -

Maintainer(s)

The currently active maintainer(s) of this project.

• Bikram Ghuku

Creator(s)

Honoring the original creator(s) and ideator(s) of this project.

• Arpit Bhardwaj

(back to top)

Additional documentation

• License
• Code of Conduct
• Security Policy
• Contribution Guidelines

(back to top)