Skip to content

Hub interface for managing and updating all Demido services.

License

Notifications You must be signed in to change notification settings

Demido-Ltd/shell

Repository files navigation

Banner

⚠️ THIS PROJECT IS UNDER HEAVY DEVELOPMENT. The project is not yet ready for public use, as breaking updates and refactoring are quite a common happening at this stage.

This README page is also under development.


The Demido Shell serves as the core component of the Demido project, providing a unified and efficient interface for managing and interacting with Demido services. It is designed to streamline the process of running, monitoring, and controlling various platform bots from a single, cohesive environment.

This shell allows to easily initiate and manage services, ensuring seamless communication and operation between different services and platform bots. Its intuitive architecture simplifies complex tasks, making it accessible for developers and system administrators alike.

The Demido Shell is the backbone of the Demido ecosystem, ensuring that all components work together in harmony, empowering us to focus on our development goals without worrying about underlying complexities.

Installation and runtime

Clone the repository

git clone https://github.com/Demido-Ltd/shell.git "./Demido Shell"

You may also want to enter the folder so you can follow through the next steps.

cd "./Demido Shell"

Install packages

We highly recommend and support the use of bun for optimal performance. While you can still install packages using npm install, building and running the shell with tools other than bun may result in unforeseen issues. Please note that we do not offer support for problems arising from using alternative tools.

If you do not have bun use one of the following commands:

For Windows users:

powershell -c "irm bun.sh/install.ps1 | iex"

For Linux & Mac OS users:

curl -fsSL https://bun.sh/install | bash

This command will install all the required dependencies for the project to run smoothly:

bun install
Please note that this will also install all the packages required by the various bots and services. Most of the libraries we use are very lightweight and will not run unless you also have the bot or service running, however you may want to check package.json and remove any packages you might not need or want. Please be careful while doing so as it may lead to unexpected errors.

Start the shell

bun run start
It is also possible to start the shell by running bun index.ts.