Skip to content
This repository was archived by the owner on Mar 14, 2025. It is now read-only.

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

❗️ Install:

Fully automated install

# Installing Docker image on Linux and MacOS
$ ./install-docker.sh

# Install Docker image on Windows
$ docker build -t moo .

# Installing pure build
$ ./install.sh

Manual install

🐧 Linux

  1. Move to web/ directory

  2. Setup pnpm environment:

$ pnpm install && cd frontend; pnpm install
  1. Build and run:
# The step above will move your directory, take a step back to run all properly
$ cd ../

# If you wanna run in development mode, just run `pnpm run dev`
$ pnpm run build

$ pnpm run start # By default web interface's location is http://localhost:3000/

Creating a shell script to automate deploy on system startup

  1. Move the directory for a most positional location or still using the same (I personally recommend moving to "/opt").

  2. Get full path of builded "moo" (normally /yourpath/moo/web)

  3. Let's write a shell script (moo.sh):

#!/bin/bash

# The path you chose goes here
cd PATHYOUCHOSE/moo/web

# Make sure you builded backend and frontend!!!
pnpm run start
  • Now you can use that shell script to run the server on computer startup.

Example with systemd:

  1. Let's write the service (moo.service):
[Service]
Type=simple
ExecStart=/bin/bash /PATH/TO/moo.sh

[Install]
WantedBy=multi-user.target
  1. Move the service to /etc/systemd/system (Needs sudo)

  2. Giving permission and enabling

$ chmod 644 /etc/systemd/system/moo.service

$ sudo systemctl enable moo.service

$ sudo systemctl start moo.service
  1. OPCIONAL: If you want to check if is everything ok, you could run systemctl status moo

🪟 Windows

  1. Move to web/

  2. Setup pnpm environment:

$ pnpm install

$ cd frontend

$ pnpm install
  1. Build and run:
# The step above will move your directory, take a step back to run all properly
$ cd ../

# If you wanna run in development mode, just run `pnpm run dev`
$ pnpm run build

$ pnpm run start # By default web interface's location is http://localhost:3000/

I can't provide a guide to run on startup cause I don't have access to a Windows system. Maybe any guide of how to run scripts/programs on Windows startup can serve your desires. (Feel free to made a PR implementing a guide!!)