From f23e9115fc5cce5e2a85e2bbc5b5392bad876f84 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Tue, 23 Jan 2024 01:22:36 +0900 Subject: [PATCH] docs: add developer/install-and-prerequisites --- .../04-install-and-prerequisites.md | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 docs/docs/developer/01-overview/04-install-and-prerequisites.md diff --git a/docs/docs/developer/01-overview/04-install-and-prerequisites.md b/docs/docs/developer/01-overview/04-install-and-prerequisites.md new file mode 100644 index 000000000..dbc39fccd --- /dev/null +++ b/docs/docs/developer/01-overview/04-install-and-prerequisites.md @@ -0,0 +1,65 @@ +--- +title: Installation and Prerequisites +slug: /developer/install-and-prerequisites +description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + installation, + prerequisites, + developer setup, + ] +--- + +## Requirements: + +- [Hardware Requirements](../../guides/02-installation/06-hardware.md) + +- System Requirements: + - [Windows](../../install/windows/#system-requirements) + - [MacOS](../../install/mac/#system-requirements) + - [Linux](../../install/linux/#system-requirements) + +## Prerequisites + +Before installing Jan, make sure you have the following installed on your computer: + +- [Node.js](https://nodejs.org/en/) (version 20.0.0 or higher) +- [yarn](https://yarnpkg.com/) (version 1.22.0 or higher) +- [make](https://www.gnu.org/software/make/) (version 3.81 or higher) + +## Instructions + +1. Clone the repository and install dependencies + +```bash +git clone https://github.com/janhq/jan +cd jan +git checkout -b DESIRED_BRANCH +yarn install +``` + +2. Run development and use Jan Desktop + +```bash +make dev +``` + +This will start the development server and open the Jan Desktop app. + +## For Production Build + +```bash +# Do steps 1 and 2 in the previous section +# Build the app +make build +``` + +This will build the app MacOS (M1/M2/M3) for production (with code signing already done) and put the result in dist folder.