vaccarini-lorenzo / privtap Goto Github PK

PrivTAP

A Trigger-Action Platform where privacy comes first!

View Demo · Report Bug · Request Feature

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)

(back to top)

• Node & NPM
• MongoDB

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)

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

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)

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

(back to top)

Email: [email protected]

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

(back to top)

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

• Alessandro Sassi
• Emanuele Santoro
• Enna Basic
• Ivan Radonjic
• Michele Benedetti
• Leonardo Panseri
• Lorenzo Vaccarini

(back to top)