https://github.com/lostdusty/tunebot
TuneIn bot for Discord
https://github.com/lostdusty/tunebot
Last synced: 11 months ago
JSON representation
TuneIn bot for Discord
- Host: GitHub
- URL: https://github.com/lostdusty/tunebot
- Owner: lostdusty
- License: apache-2.0
- Created: 2023-10-19T23:12:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T23:12:20.000Z (over 2 years ago)
- Last Synced: 2025-01-16T07:55:19.686Z (over 1 year ago)
- Language: TypeScript
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sapphire.js Template
## Getting Started
Clone the repository and install the dependencies using [PnPM](https://pnpm.io/):
```bash
git clone https://github.com/mauriciobraz/sapphire.js-template.git
cd sapphire.js-template
pnpm install
```
### Renaming the Project
**Linux**
```bash
set NAME="my-project"
find . -type f -exec sed -i 's/sapphire.js-template/$NAME/g' {} +
```
**Windows**
```bash
set NAME="my-project"
PowerShell -Command "Get-ChildItem -Recurse | ForEach-Object { if ($_.Name -ne 'rename.ps1') { (Get-Content $_.FullName) -replace 'sapphire.js-template', '%NAME%' | Set-Content $_.FullName } }"
```
### Running the Project
```bash
# Copy the `.env.example` file to `.env` and fill the variables.
pnpm dev
```
## Project Structure
1. **Constants** are any constant value that will be used in the project.
2. **Modules** are any `sapphire.js` module (command, listener, etc.).
3. **Utilities** are any utility function that will be used in the project.
1. Prefix the file name with `_` if it's not a Sapphire.js utility class.