Skip to content

Latest commit

 

History

History
144 lines (102 loc) · 2.46 KB

README.md

File metadata and controls

144 lines (102 loc) · 2.46 KB
Raw

Confidant

Soverant application

Features

  • under construction

Requirements

  • Python 3.8+
  • Node.js 12+

Installation

Clone the Repository

git clone [email protected]:soverant/poc.git
cd poc

Set Up Python Environment

  1. Create a virtual environment: 
    python -m venv venv
  2. Activate the virtual environment:
    • On Windows: 
      venv\Scripts\activate
    • On macOS and Linux: 
      source venv/bin/activate

Install Dependencies

You can install all dependencies for both the back-end and front-end using the main.py script.

python main.py development --install

Alternatively, you can install dependencies manually:

Back-end (FastAPI)

pip install -r backend/requirements.txt

Front-end (Next.js)

cd frontend
npm install

Running the Application

You can run the application in either development or production mode using the main.py script.

Development Mode

python main.py development

Production Mode

python main.py production

Generation Mode

  • update backend openapi spec at ./backend/openapi.json
  • generate frontend client at ./frontend/src/app/lib/generated-client
python main.py generation

Configs:

project use .env and environment variable to read config:

Backend

OPENAI_TOKEN="YOUR OPENAI TOKEN"
LOG_LEVEL=""
HOST=""
PORT=""
ENVIRONMENT=""
ORM_DB_URL=""
UNMANAGED_DB_URL=""
OPENAI_TOKEN=""

Frontend

NEXT_PUBLIC_API_BASE_URL="API Server URL"

Logging

The application streams logs from both the FastAPI back-end and the Next.js front-end to the console using the Python logging module.

Contributing

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments