Update README.md

This commit is contained in:
Wlad Meixner 2023-01-08 13:06:44 +01:00 committed by GitHub
parent 247f978c7b
commit 0635c88781
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1 +1,34 @@
# ComplAI
![ComplAI](https://complai.de/logo-header@3x.png)
## Product not yet ready!
This project was developed for the [LegalLovesTech](https://legallovestech.de/) Hackathon and not production ready in any way!
This is a web-based legal law notification system built with Svelte and OpenAI. It is designed to help individuals and organizations stay up-to-date on the latest legal laws and regulations in their jurisdiction.
## Features
- Real-time notifications of new legal laws and regulations
- Customizable notification settings
- Searchable database of legal laws and regulations
- Automatic scraping of changes to current laws and regulations
## Tech Stack
Svelte: A modern JavaScript framework for building web applications
OpenAI: A leading artificial intelligence research laboratory
Getting Started
Clone the repository: `git clone https://github.com/gosticks/complai.git`
Install dependencies: `pnpm install`
Run the development server: `pnpm run dev`
## Deployment
Build the production version of the app: pnpm run build
Deploy the built app to your preferred hosting platform (e.g. GitHub Pages, AWS, etc.)
Contribution
If you would like to contribute to the development of this legal law notification system, please fork the repository and submit a pull request. All contributions are welcome!
## Deployment of Server and Scraper
- TBD