ganzux/pisa-slack

PISA

Personnel Integration Slack Application
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • TODO List
2. Getting Started
   • Prerequisites
   • Installation
3. Screenshots
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

PISA is your personnal assistant for HR interactions within SLACK!

Built With

• Java: Java is a high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible.

• SpringBoot: Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "just run".

• Slack: Slack is a new way to communicate with your team. It's faster, better organized, and more secure than email.

• Slack Bolt: a foundational framework for Slack apps.

• ngrock: ngrok provides a real-time web UI where you can introspect all HTTP traffic running over your tunnels. Replay any request against your tunnel with one click.

• Heroku: Heroku is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud.

TODO List

1. Decouple into a Data microservice and a services microservice
2. TESTS!
3. Introduce Mappers for DTO/Data Objects
4. Flyway for migrations in DB
5. Default Dates in main screen
6. Refresh main screen after recording a TS
7. Integrate with commands
8. Default project - Last one used
9. Translate
10. ...

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• maven
• Java 1.8+
• ngrok

Installation

1. Clone the repo

   git clone https://github.com/ganzux/pisa-slack.git

2. Build the project

   mvn package

3. Start a ngrock instance

   ./ngrok http 3000

4. Point your SLACK app to the HTTPS url provided by ngrok

   https://17de9bbc1338.ngrok.io -> http://localhost:3000
   

5. Start your SpringBoot App in the port 3000

   mvn spring-boot:run 

Screenshots

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

Your Name - @ganzux - email

Project Link: https://github.com/ganzux/pisa-slack