Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lambdacasserole/data-protection-coach

A project implementing a simple AI startup idea. Used for my talk on startup building.
https://github.com/lambdacasserole/data-protection-coach

ai business-intelligence entrepreneurship ml teaching

Last synced: 12 days ago
JSON representation

A project implementing a simple AI startup idea. Used for my talk on startup building.

Host: GitHub
URL: https://github.com/lambdacasserole/data-protection-coach
Owner: lambdacasserole
License: mit
Created: 2023-11-29T09:23:12.000Z (12 months ago)
Default Branch: main
Last Pushed: 2023-12-13T13:58:12.000Z (11 months ago)
Last Synced: 2024-10-10T22:15:01.480Z (about 1 month ago)
Topics: ai, business-intelligence, entrepreneurship, ml, teaching
Language: TypeScript
Homepage: https://dataprotection.coach
Size: 432 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Data Protection Coach

A project implementing a simple AI startup idea to help businesses achieve GDPR compliance. Used for my talk on startup building.

![Logo](public/logo.svg)

## Prerequisites

Before you begin, ensure you have met the following requirements:

- [Node.js](https://nodejs.org/) installed on your machine. The project has been developed and tested with Node.js version 18.6.0. You can download the latest version of Node.js from [https://nodejs.org/](https://nodejs.org/).

### Verifying Node.js Installation

To check if Node.js is installed, open a command prompt or terminal window and run the following commands:

```bash
node --version
```

This should display the installed Node.js version. Additionally, you can check the npm version:

```bash
npm --version
```

Make sure both commands return valid version numbers.

### Installing Visual Studio Code (Recommended)

Visual Studio Code is the recommended code editor for this project. Follow these steps to install it:

1. Visit the [Visual Studio Code website](https://code.visualstudio.com/).
2. Download the installer for your operating system (Windows, macOS, or Linux).
3. Run the installer and follow the on-screen instructions.
4. After installation, open Visual Studio Code.

## Installing Dependencies

Once Node.js is installed, navigate to the project's root directory using the command line and run the following command to install the project dependencies:

```bash
npm install
```

This will download and install the necessary packages specified in the `package.json` file.

## Setting Up Environment Variables

Your app needs to be able to connect to a database as well as the OpenAI API in order to function. If you're in class, your teacher can provide these to you if you don't have them to hand. Otherwise you'll need to set up a database (e.g. using [Railway](https://docs.railway.app/guides/mysql)) and [register your own OpenAI API key](https://platform.openai.com/docs/quickstart?context=python).

1. **Database Connection (DATABASE_URL):**
- Copy the file called `.env.example` a new file named `.env` in the root directory of your project.
- Inside the `.env` file, add the following line and replace `` with the actual connection URL for your database:

```env
DATABASE_URL=""
```

- Save the `.env` file.

2. **OpenAI API Key (OPENAI_API_KEY):**
- This project makes use of the OpenAI API, which requires an API key. To install it, add another line to your `.env` file:

```env
OPENAI_API_KEY=""
```

- Replace `` with your actual OpenAI API key.

- Save the `.env` file.

## Running the Project

After installing the dependencies, you can run the project using the following command:

```bash
npm start
```

This will start the application, and you can access it by navigating to [http://localhost:3000](http://localhost:3000) in your web browser.

## Making the Project Yours

Included in this project is `quickstart.py`, a script that will allow you to customise the app to your chosen problem domain quickly and easily. To get started, run:

```bash
python3 quickstart.py
```

The script will guide you through the rest of the process.

## Deploying on Vercel (Optional)

If you wish to deploy your project on Vercel, an easy-to-use platform for hosting web applications, follow this [Vercel deployment tutorial](https://vercel.com/docs/platform/deployments). If you're in class, there's no need to do this unless you actually want to take things further outside the classroom by opening your app up to real users!

## Acknowledgements

This app is built on the awesome [T3 stack](https://create.t3.gg/).

## Copyright and License