Go to file
2023-01-23 19:40:09 +01:00
backend Let OpenAI know that the only german lawcode is 238 2023-01-23 19:40:09 +01:00
frontend Add main section 2023-01-22 17:15:38 +01:00
.gitignore Initial page 2023-01-11 23:44:08 +01:00
docker-compose.yml css prefix fix and permission fix 2023-01-14 15:29:17 +01:00
LICENSE Initial commit 2023-01-11 21:46:41 +01:00
README.md Update README.md 2023-01-22 18:39:04 +01:00

StalkingAId

Product not yet ready!

This project was developed for the Tech Challenge and is not production ready in any way!

This is a web-based digital assistant chatbot system built with Svelte and OpenAI. It is designed to empathize with victims of stalking.

Features

  • 24/7 personalized, empathic and intelligent assistant
  • Anonymous & secure
  • Zero obligations, offers buffet like possibilities, e.g. call/report to police, fill psychological symptoms list, contact oranizations such as Weisser Ring / Telefonseelsorge, start taking daily notes ("stalking diary") using NO STALK

Tech Stack

Svelte: A modern JavaScript framework for building web applications

OpenAI: A leading artificial intelligence research laboratory

Docker: A software virtualization platform, used for easy deployment

Deployment

Getting Started

Clone the repository: git clone https://github.com/wasnertobias/StalkingAId.git

Do configure OPEN_AI_API_KEY and ACCESS_TOKEN (used to secure the access of the backend server, as it is currently not publicly accessible) in the predefined docker-compose.yml

Launch docker containers: docker-compose up -d

By default the frontend server runs locally on port 25543 and the backend server locally on port 25544. Both are not exposed to any external network interfaces. Thus more configuration (e.g. a HTTPS reverse Proxy using nginx) is needed. Example configuration:

    location / {
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-NginX-Proxy true;
        proxy_pass http://localhost:25543;
        proxy_ssl_session_reuse off;
        proxy_set_header Host $http_host;
        proxy_cache_bypass $http_upgrade;
        proxy_redirect off;
    }

    location /api {
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-NginX-Proxy true;
        proxy_pass http://localhost:25544;
        proxy_ssl_session_reuse off;
        proxy_set_header Host $http_host;
        proxy_cache_bypass $http_upgrade;
        proxy_redirect off;
    }

Note: The backend server is used to call the OpenAI-API and the frontend server is being used to serve the static frontend assets to the browser.

Updates: Can be realized with re-building the docker containers docker-compose build and re-starting them docker-compose up -d

Contribution

If you would like to contribute to the development of this digital assistant, please fork the repository and submit a pull request. All contributions are welcome!