71 lines
1.1 KiB
Markdown
71 lines
1.1 KiB
Markdown
# Kiku
|
|
|
|
## TODO
|
|
|
|
Add lavalink
|
|
|
|
## Packages
|
|
|
|
https://github.com/discordjs/discord.js
|
|
|
|
https://github.com/shipgirlproject/Shoukaku
|
|
|
|
https://github.com/Takiyo0/Kazagumo
|
|
|
|
https://www.npmjs.com/package/kazagumo-spotify
|
|
|
|
<!-- gen-readme start - generated by https://github.com/jetpack-io/devbox/ -->
|
|
|
|
## Getting Started
|
|
|
|
This project uses [devbox](https://github.com/jetpack-io/devbox) to manage its development environment.
|
|
|
|
Install devbox:
|
|
|
|
```sh
|
|
curl -fsSL https://get.jetpack.io/devbox | bash
|
|
```
|
|
|
|
Start the devbox shell:
|
|
|
|
```sh
|
|
devbox shell
|
|
```
|
|
|
|
Run a script in the devbox environment:
|
|
|
|
```sh
|
|
devbox run <script>
|
|
```
|
|
|
|
## Scripts
|
|
|
|
Scripts are custom commands that can be run using this project's environment. This project has the following scripts:
|
|
|
|
- [run_test](#devbox-run-run_test)
|
|
|
|
## Shell Init Hook
|
|
|
|
The Shell Init Hook is a script that runs whenever the devbox environment is instantiated. It runs
|
|
on `devbox shell` and on `devbox run`.
|
|
|
|
```sh
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
## Packages
|
|
|
|
- [nodejs@18](https://www.nixhub.io/packages/nodejs)
|
|
|
|
## Script Details
|
|
|
|
### devbox run run_test
|
|
|
|
```sh
|
|
npm run start
|
|
```
|
|
|
|
 
|
|
|
|
<!-- gen-readme end -->
|