ZINF-TC39 (In development)

About the project

We have been tasked with improving the accessibility and readability of the TC39 meeting notes. Our application simplifies the process of viewing these notes. We've organized all meeting documents into a tree structure, making it easier to find specific files. Additionally, we've incorporated a sentiment analysis tool. This feature allows users to select portions of text and analyze their sentiment. We've also integrated the ChatGPT API. Now, users can engage in conversations with context from the marked sections of the markdown (MD) files.

Getting Started

Prerequisites

Ensure you have the following installed:

• Python
• Node.js
• pip

Installation

Clone the repository and install dependencies:

git clone https://github.com/INF218-Group-Project/TC39-Meeting-Minutes-Viewer
cd TC39-Meeting-Minutes-Viewer
npm install

If you encounter a notification about missing components, use the command 'npm i [Name of Missing Component]' to install them individually.

Example:

pip install stanza

To install what is needed do this:

npm i

Configuration - Insert ChatGPT API Key

This application uses ChatGPT API. If you want to have these features, which is recommended for the full experience of the application, please do as follows:

Obtain a ChatGPT API key and insert it into the file ".env_sample.txt". After the key has been inserted, the filename needs to be changed to ".env". It will be automatically hidden from git in ".gitignore".

If the .env_sample.txt file is nowhere to be found, you will have to make the file ".env" in the outermost directory (TC39-Meeting-Minutes-Viewer). In this file you need to insert the following code and insert your ChatGPT API Key at [Insert your key here]

VITE_REACT_APP_OPENAI_API_KEY = [Insert your key here]

Chat API should now work.

Running the Application

Start the application in development mode:

npm run dev

Tech/Framework used

TODO:

• Built with:
  • React
  • Electron
  • MUI

API Reference

TODO:

Resources

https://nodejs.org/en/download https://pip.pypa.io/en/stable/installation/ https://www.electronjs.org/ https://react.dev/ https://www.python.org/ https://www.typescriptlang.org/ https://www.javascript.com/ https://openai.com/

TODO: Our agile project board.

Screenshots

Light Mode

Dark Mode

Credits

in alphabetical order:

Brage Løvfall Aasen

Casper Benjamin Karlsen

Elias Hovdenes

Magnus Sponnich Brorby

Vetle Mathiesen Knutsen