Slackify API is a web application built with NestJS, Prisma, Supabase DB, and Slack API. This application is designed to post messages to your Slack channel automatically based on various features.
- Custom Notification
- Weekly Trending Topic of React
- Daily Fun and Programming Quiz
- Daily Alert for Check-In and Check-Out
- NestJS: https://nestjs.com/
- Prisma: https://www.prisma.io/
- Supabase DB: https://supabase.com/
- Slack API: https://api.slack.com/messaging/webhooks
To get started with the Slackify API, you will need to create a new Slack app and obtain a Bot User OAuth Access Token. You will also need to create a Supabase account and obtain an API key. Once you have these credentials, you can follow the steps below:
- Clone the repository to your local machine.
git clone https://github.com/nhemnt/slackify-api.git
- Install dependencies.
cd slackify-api
yarn
- Create a .env file in the root directory of the project and add the following environment variables.
API_SECRET_KEY=
EXCLUDED_LIST = '["@gmail","Retweet"]'
EXCLUDED_DOMAIN = '["twitter","youtube","github"]'
WEBHOOK_URI=
# PunchInOut channel
WEBHOOK_URI_PUNCH_IN_OUT=
DIRECT_URL=""
DATABASE_URL=""
- Run the application.
yarn start:dev
- Navigate to http://localhost:8081/docs to access the Swagger UI documentation and test the API endpoints.
Contributions are welcome! If you'd like to contribute to this project, please fork the repository and create a new branch for your feature or bug fix. Once you've made your changes, submit a pull request and we'll review your code.
This project is licensed under the MIT License. Feel free to use, modify, and distribute this code as you see fit.