This is the Mikugg project, which includes multiple applications and services. This README provides instructions on how to set up and run the project on both Windows and Linux.
- Python 3.9: Download and install from https://www.python.org/downloads/
- Node.js: Download and install from https://nodejs.org/en/download/
- Pip: Download and install from https://pip.pypa.io/en/stable/installation/
Note On windows, Make sure to add Python, Node.js, and pip to your system's PATH.
-
Double-click
install.bat
or run it in the command prompt. This will install the necessary dependencies for both Node.js and Python projects. -
The script will prompt you for optional API keys. Enter the keys when prompted or leave them blank if you don't have them.
-
Open a terminal and navigate to the project root directory.
-
Run
make install
. This will install the necessary dependencies for both Node.js and Python projects. -
The script will prompt you for optional API keys. Enter the keys when prompted or leave them blank if you don't have them.
- Double-click
run.bat
or run it in the command prompt. This will start both the Node.js and Python servers.
-
Open a terminal and navigate to the project root directory.
-
Run
make run
. This will start both the Node.js and Python servers.
The UIs that are up an running are
# Bot directory UI
http://localhost:8585/
# Chat interactor UI
http://localhost:5173/
# Bot Builder UI
http://localhost:8586/
For more information on how to use the Mikugg project, please refer to the official documentation at https://docs.miku.gg.
pnpm install
pnpm build
pnpm run
# hotfix for vite not refreshing deps
# need to restart the app with this command if you edit the deps under package/
rm -rf apps/browser-chat/node_modules/.vite && pnpm start
To sync with the lastest version from git, just run
pnpm pull
# publish public packages to npm
npx lerna publish