Skip to content

PrivTap/PrivTap

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

PrivTAP

A Trigger-Action Platform where privacy comes first!

View Demo · Report Bug · Request Feature

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

About The Project

PrivTAP Screen Shot

PrivTAP is a Trigger-Action Platform built around the key concepts of privacy and user control over its personal data. On this platform users can configure automation rules in the format: IF <trigger> THEN <action>. Triggers and actions are provided by third-party services, that can offer personalized operations to users thanks to OAuth2 authorization. Users have granular control on what personal data the platform can access.

(back to top)

Built With

  • Node
  • Vue
  • Vite
  • Tailwind
  • Express
  • MongoDB

(back to top)

Getting Started

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/privtap/privtap.git
  2. Build frontend Single Page Application
    cd <path_to_cloned_repo>/frontend/
    npm install
    npm run build
  3. Build backend Express appserver (two options)
    • Local Express appserver
      cd <path_to_cloned_repo>/backend/
      npm install
      npm run build
    • Docker container
      cd <path_to_cloned_repo>/backend/
      docker build . -t privtap/backend

(back to top)

Usage

You must set several environment variables in order to execute the backend, any variable that does not have a default is mandatory:

Environment variable Description Default
PORT the port for the appserver to listen on 3000
BASE_URL the base URL from which the routes will start /
EXPRESS_STATIC_FILES path to a folder from which the appserver will serve static files, if this is undefined, the appserver will not serve static files undefined
NODE_ENV either development or production, control various debug feature
EMAIL_USER username for the mail server (not needed if NODE_ENV=development)
EMAIL_PASSWORD password for the mail server (not needed if NODE_ENV=development)
DB_STRING connection string for a MongoDB database
JWT_SECRET secret used to encrypt JWT tokens
JWT_EXPIRE expiration time for JWT tokens (in seconds)

The variables can be set in a .env file located in the backend/ folder.

The simplest way to start a local development environment is by running the run_dev.sh script. This will start a local Express appserver that serves both the REST API (at http://127.0.0.1:<PORT>/api/) of the backend and the Single Page Application of the frontend (at http://127.0.0.1:<PORT>/). Otherwise, you can build the frontend and the backend separately and deploy them as you like.

(back to top)

License

Distributed under the GPL-2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Email: contact@privtap.it

GitHub: https://github.com/privtap/privtap

(back to top)

Acknowledgments

Thanks to all team members that have worked on this project:

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7