Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finalize install and prerequisitites

Browse Source
This commit is contained in:
hieu-jan 2024-01-23 03:00:51 +09:00
parent 7c0c6924d8
commit b14ff4cdb5
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/developer/01-overview/04-install-and-prerequisites.md
View File

@ -35,7 +35,7 @@ keywords:
## Instructions ## Instructions
1. Clone the repository and install dependencies 1. **Clone the Repository:**
```bash ```bash
git clone https://github.com/janhq/jan git clone https://github.com/janhq/jan
@ -43,19 +43,19 @@ cd jan
git checkout -b DESIRED_BRANCH git checkout -b DESIRED_BRANCH
``` ```
2. Install dependencies 2. **Install Dependencie:s**
```bash ```bash
yarn install yarn install
``` ```
3. Run development and use Jan Desktop 3. **Run Development and Use Jan Desktop**
```bash ```bash
make dev make dev
``` ```
This will start the development server and open the Jan Desktop app. This command starts the development server and opens the Jan Desktop app.
## For Production Build ## For Production Build
@ -65,4 +65,8 @@ This will start the development server and open the Jan Desktop app.
make build 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. 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](../../troubleshooting/stuck-on-broken-build) guide.