Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add readme for the application setup instructions #129

Merged
merged 3 commits into from
Mar 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions edgen/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Edgen
A Local GenAI API Server: A drop-in replacement for OpenAI's API for Local GenAI
- [Description](#description)
- [Getting Started](#getting-started)
- [Dependencies](#dependencies)
- [Installing](#installing)
- [Executing program](#executing-program)
- [Documentation](#documentation)
- [Help](#help)
- [Running the Application Locally](#running-the-application-locally)
- [License](#license)

## Description

Edgen is a Local, private GenAI server alternative to OpenAI. No GPU is required. Run AI models locally: LLMs (Llama2, Mistral, Mixtral...), Speech-to-text (whisper) and many others.

## Getting Started

### Dependencies

- [Rust](https://www.rust-lang.org/tools/install)
- [NodeJs](https://nodejs.org/en/download/)
- [pnpm](https://pnpm.io/installation)

### Installing

See the [releases](https://github.com/edgenai/edgen/releases) page for the latest binary. All major platforms are supported.


## Documentation
See the [documentation page](https://docs.edgen.co) for help and support

## Help
Should any error be encountered when building the application locally, ensure the following system dependencies are met

1. Minimum Required Rust Toolchain
```shell
# use the rustup toolchain command to install the required toolchain
rustup toolchain add beta-2023-11-21
```

2. Install cmake from [https://cmake.org/download/](https://cmake.org/download/)

## Running the Application Locally
To run the application locally, ensure the dependencies are met
```shell
pnpm install
pnpm tauri dev
```



## License

This project is licensed under the Apache 2.0 License - see the [LICENSE](../LICENSE) file for details

Loading