Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
jan/docs/docs/developer/01-overview/04-install-and-prerequisites.md
hieu-jan 1074d84841 fix: thumbnail
2024-03-19 15:11:11 +09:00

2.8 KiB
Raw Blame History

title slug description keywords
Installation and Prerequisites /developer/prereq Guide to install and setup Jan for development.
Jan AI
Jan
ChatGPT alternative
local AI
private AI
conversational AI
no-subscription fee
large language model
installation
prerequisites
developer setup
<head> </head>

Requirements

Hardware Requirements

Ensure your system meets the following specifications to guarantee a smooth development experience:

  • Hardware Requirements

System Requirements

Make sure your operating system meets the specific requirements for Jan development:

Prerequisites

  • Node.js (version 20.0.0 or higher)
  • yarn (version 1.22.0 or higher)
  • make (version 3.81 or higher)

Instructions

  1. Clone the Repository:
git clone https://github.com/janhq/jan
cd jan
git checkout -b DESIRED_BRANCH
  1. Install Dependencies
yarn install
  1. Run Development and Use Jan Desktop
make dev

This command starts the development server and opens the Jan Desktop app.

For Production Build

# 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 place the result in /electron/dist folder.

Troubleshooting

If you run into any issues due to a broken build, please check the Stuck on a Broken Build guide.