Code Monkey home page Code Monkey logo

miku's Introduction

Mikugg Project

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.

Prerequisites

Note On windows, Make sure to add Python, Node.js, and pip to your system's PATH.

Installation

Windows

  1. Double-click install.bat or run it in the command prompt. This will install the necessary dependencies for both Node.js and Python projects.

  2. The script will prompt you for optional API keys. Enter the keys when prompted or leave them blank if you don't have them.

Linux

  1. Open a terminal and navigate to the project root directory.

  2. Run make install. This will install the necessary dependencies for both Node.js and Python projects.

  3. The script will prompt you for optional API keys. Enter the keys when prompted or leave them blank if you don't have them.

Running the Project

Windows

  1. Double-click run.bat or run it in the command prompt. This will start both the Node.js and Python servers.

Linux

  1. Open a terminal and navigate to the project root directory.

  2. Run make run. This will start both the Node.js and Python servers.

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/

Documentation

For more information on how to use the Mikugg project, please refer to the official documentation at https://docs.miku.gg.

Local Development (Linux)

pnpm install
pnpm build

run

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 

Pull new changes

To sync with the lastest version from git, just run

pnpm pull

publish

# publish public packages to npm
npx lerna publish --no-private

miku's People

Contributors

miku448 avatar rs15z avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.