Skip to content

lokeswaran-aj/LocalGPT

Repository files navigation

LocalGPT

LocalGPT is an open source alternative to ChatGPT, allowing users to run ChatGPT functionalities with any open source large language model (LLM) locally. This project aims to provide a flexible and customizable chat interface leveraging open source LLMs for a variety of applications.

Features

  • Local Deployment: Run ChatGPT functionalities on your local machine with any open source LLM.
  • Customizable Interface: Easily customize the chat interface to fit your needs.
  • Flexibility: Supports a wide range of open source LLMs for diverse use cases.
  • Privacy: Keep your data private by running everything locally.

Installation

Prerequisites

  • Node.js (v20.11.1 or later)
  • pnpm (v9.4.0 or later)

Steps

  1. Clone the repository:

    git clone https://github.com/lokeswaran-aj/LocalGPT.git
    cd LocalGPT
  2. Install dependencies:

    pnpm install
  3. Run the project:

    pnpm dev
  4. Access the chat interface:

    Open your web browser and navigate to http://localhost:3000 to access the chat interface.

Contributing

We welcome contributions to LocalGPT! Please follow these steps to contribute:

  1. Fork the repository:

    Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.

  2. Clone your fork:

    git clone https://github.com/yourusername/LocalGPT.git
    cd LocalGPT
  3. Create a new branch:

    git checkout -b feature/your-feature-name
  4. Make your changes:

    Implement your feature or fix the bug you found.

  5. Commit your changes:

    git add .
    git commit -m "Add your feature or fix description"
  6. Push to your fork:

    git push origin feature/your-feature-name
  7. Create a pull request:

    Go to the original repository and click "New pull request" to submit your changes for review.

License

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

Acknowledgements

  • OpenAI for inspiring the creation of this project.

Contact

For questions or support, please open an issue on the GitHub repository