Skip to content

hacanand/workflow

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Workflow

A Project to Automate the simple Task
Visit Site»

. Report Bug · Request Feature.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

Workflow Automation Platform
Welcome to the Workflow Automation Platform! This project aims to streamline and automate various tasks and processes, integrating with multiple services like Google Drive, Slack, Notion, and more.

This Platform is designed to help users automate repetitive tasks by creating workflows that integrate with various third-party services. Whether you need to send notifications, create calendar events, or manage files, this platform provides a flexible and powerful solution.

(back to top)

Built With

This project is built with the following technologies:

  • Next
  • Typescript
  • Tailwind
  • Shadcn
  • Clerk
  • Stripe

(back to top)

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.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your workflow doesn't rely on any external dependencies or services.

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/hacanand/workflow.git
  3. Install NPM packages
    npm install
  4. Enter your API in .env.example
  5. Rename .env.example to .env
  6. Run the project
    npm run dev
  7. Open your browser and go to https://localhost:3000

(back to top)

Usage

Below is an example of how you can use the workflow to automate a simple task.

  • Click on Dashboard and Login with your credentials or Sign Up if you don't have an account.(Google sign)
  • Click on Workflow in the left sidebar of the dashboard.
  • Click on Create Workflow.
  • Select the Trigger Event. For example, you can select "New File Uploaded" from Google Drive.
  • Select the Action Event. For example, you can select "Send Notification" to Slack.
  • Click on Save Workflow.
  • Now, whenever a new file is uploaded to Google Drive, a notification will be sent to Slack.

(back to top)

Roadmap

[x] Add Google Drive Integration
[x] Add Slack Integration
[x] Add Notion Integration
[ ] Add Calendar Integration
[ ] Add Email Integration

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

(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!

How to Contribute

  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)

License

Distributed under the MIT License.

(back to top)

Contact

Your Name - @be_amrit

Project Link: https://github.com/hacanand/workflow

(back to top)

Acknowledgments

(back to top)

Releases

No releases published

Packages

No packages published

Languages