OpenWebUI/desktop
1
0
Fork 0
mirror of https://github.com/open-webui/desktop synced 2025-06-26 18:15:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update dev.md

Browse Source
This commit is contained in:
Timothy Jaeryang Baek 2025-01-12 19:18:52 -08:00
parent ff8fa70dc4
commit 7b69e0a6bb
1 changed files with 10 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
dev.md
View File

@ -1,63 +1,56 @@
# Developer Documentation # Developer Documentation
## Prerequisites ## Prerequisites
To work on this Electron project, you must have the following installed: To work on this Electron project, you must have the following installed:
- **Conda**: A package, dependency, and environment management tool. - **Conda**: A package, dependency, and environment management tool.
- **conda-pack**: To pack Conda environments into tarballs. - **conda-pack**: To pack Conda environments into tarballs.
- **conda-lock**: To generate lockfiles for Conda environments. - **conda-lock**: To generate lockfiles for Conda environments.
- **Node.js 22+**: Ensure that your Node.js version is at least 22 (tested with v22.10).
Ensure these tools are properly installed and configured before proceeding. ### Installation Notes
- Install **conda-pack** and **conda-lock** globally or ensure they are available in the project's Python environment (e.g., a virtual environment).
- Double-check your tool versions to avoid compatibility issues.
--- ---
## Getting Started ## Getting Started
1. **Clone the repository**: 1. **Clone the repository**:
```bash ```bash
git clone https://github.com/open-webui/app git clone https://github.com/open-webui/app
cd app cd app
``` ```
2. **Install Node.js dependencies**: 2. **Install Node.js dependencies**:
```bash ```bash
npm i npm i
``` ```
3. **Generate the Python environment tarball**: 3. **Generate the Python environment tarball**:
```bash ```bash
npm run create:python-tar npm run create:python-tar
``` ```
> Note: This requires **conda-lock** to be installed and properly configured.
4. **Start the development environment**: 4. **Start the development environment**:
```bash ```bash
npm run start npm run start
``` ```
This will launch the project in development mode. This will launch the project in development mode.
--- ---
## Building Distributables ## Building Distributables
To generate production-ready distributables (e.g., installers or app packages), run: To generate production-ready distributables (e.g., installers or app packages), run:
```bash ```bash
npm run make npm run make
``` ```
This will create the necessary files for distribution in the `out` directory. This will create the necessary files for distribution in the `out` directory.
--- ---
## Notes ## Notes
- Ensure **conda**, **conda-pack**, and **conda-lock** are installed and working within your environment (global or virtual).
- Use Node.js **version 22+** to avoid runtime and compatibility issues (verified with v22.10).
- If you encounter issues, examine the project-specific scripts in the `package.json` file for troubleshooting.
- Always review logs carefully if commands produce errors to identify dependencies or configuration steps you might need to address.
- Make sure you have the required versions of **conda**, **conda-pack**, and **conda-lock** to avoid compatibility issues. Enjoy developing! 🚀
- If you encounter any issues, check the project-specific scripts in the `package.json` file.
Enjoy developing! 🚀