ulanch commited on
Commit
c7f0c06
·
1 Parent(s): f67cf57

docs: update README with improved structure and .env.example instructions

Browse files

- Refined project description and features section
- Added clearer setup instructions, including .env file guidance
- Improved formatting for readability and completeness

Files changed (3) hide show
  1. .devcontainer/Dockerfile +0 -7
  2. .env.example +1 -0
  3. README.md +11 -4
.devcontainer/Dockerfile DELETED
@@ -1,7 +0,0 @@
1
- FROM mcr.microsoft.com/devcontainers/python:3.9
2
-
3
- RUN apt-get update && \
4
- apt-get install -y git-lfs && \
5
- git lfs install && \
6
- apt-get clean && \
7
- rm -rf /var/lib/apt/lists/*
 
 
 
 
 
 
 
 
.env.example ADDED
@@ -0,0 +1 @@
 
 
1
+ OPENAI_API_KEY=your-openai-api-key
README.md CHANGED
@@ -13,9 +13,9 @@ pinned: true
13
 
14
  [![Hugging Face Space](https://img.shields.io/badge/🤗%20HuggingFace-LexAI-blueviolet?logo=huggingface)](https://huggingface.co/spaces/alexulanch/lexai)
15
 
16
- ## AI-Powered Legal Research Assistant (Proof of Concept)
17
 
18
- LexAI is a proof-of-concept AI-powered legal research assistant that helps users access location-specific legal information through a simple web interface. By combining large language models with structured jurisdictional data, LexAI delivers clear, tailored answers to everyday legal questions.
19
 
20
  ![LexAI Screenshot](assets/screenshot.png)
21
 
@@ -29,7 +29,7 @@ LexAI is a proof-of-concept AI-powered legal research assistant that helps users
29
  - **Modern Web Interface**: Built with Gradio for real-time interaction.
30
  - **Modular Design**: Clean separation of logic for UI, inference, and API handling.
31
  - **Fully Tested**: Unit tests cover embedding loading, matching logic, and OpenAI API integration.
32
- - **Developer Ready**: Comes with dev tools like Ruff, Black, pytest, mypy, and test coverage support.
33
 
34
  ---
35
 
@@ -61,7 +61,13 @@ pip install -r dev-requirements.txt
61
 
62
  ### 4. Set Up Environment
63
 
64
- Create a `.env` file in the root directory:
 
 
 
 
 
 
65
 
66
  ```dotenv
67
  OPENAI_API_KEY=your_openai_api_key
@@ -88,6 +94,7 @@ Then open `http://127.0.0.1:7860` in your browser.
88
  ├── assets/
89
  │ └── screenshot.png
90
  ├── dev-requirements.txt
 
91
  ├── lexai/
92
  │ ├── __main__.py
93
  │ ├── config.py
 
13
 
14
  [![Hugging Face Space](https://img.shields.io/badge/🤗%20HuggingFace-LexAI-blueviolet?logo=huggingface)](https://huggingface.co/spaces/alexulanch/lexai)
15
 
16
+ ## AI-Powered Legal Research Assistant
17
 
18
+ LexAI is an AI-powered legal research assistant that helps users access location-specific legal information through a simple web interface. By combining large language models with structured jurisdictional data, LexAI delivers clear, tailored answers to everyday legal questions.
19
 
20
  ![LexAI Screenshot](assets/screenshot.png)
21
 
 
29
  - **Modern Web Interface**: Built with Gradio for real-time interaction.
30
  - **Modular Design**: Clean separation of logic for UI, inference, and API handling.
31
  - **Fully Tested**: Unit tests cover embedding loading, matching logic, and OpenAI API integration.
32
+ - **Developer Friendly**: Includes dev tools like Ruff, Black, pytest, mypy, and coverage reports.
33
 
34
  ---
35
 
 
61
 
62
  ### 4. Set Up Environment
63
 
64
+ Copy the template and add your API key:
65
+
66
+ ```bash
67
+ cp .env.example .env
68
+ ```
69
+
70
+ Then edit `.env` and set:
71
 
72
  ```dotenv
73
  OPENAI_API_KEY=your_openai_api_key
 
94
  ├── assets/
95
  │ └── screenshot.png
96
  ├── dev-requirements.txt
97
+ ├── .env.example
98
  ├── lexai/
99
  │ ├── __main__.py
100
  │ ├── config.py