Node.js Project Template for hosting on shuttle.rs

Last update: Apr 18, 2024

Overview

Node.js on shuttle.rs Template

This Template is a starting point for creating a Node.js project on the shuttle.rs. It is a simple discord bot template that can be used to create a discord bot using the discord.js library, or any other Node.js project.

Example of a bot running on shuttle.rs:

Pre-requisites

rust installed
cargo-shuttle CLI installed
Node.js installed (obv)

Getting Started

Create a new project using the template

cargo shuttle init --from arnav-kr/node-shuttle

rename shuttle/Secrets.example.toml to shuttle/Secrets.toml and put your environment variables there. Those will be deployed to the shuttle.rs server.
restart the project
```
npm run shuttle:restart
```
deploy the project
```
npm run shuttle:deploy
```

Note

First Deploy might take some time to finish (maybe a lot) but subsequent deploys will be faster.

Note

package.json contains the shuttle: scripts to interact with the shuttle.rs server. You can use them to login, deploy, start, restart, and stop the server.

Deploy via GitHub Actions

Cosidering the deploy limit per day, the deploy workflow is opt-in by default i.e. you need to manually trigger it by putting [deploy] anywhere in your commit message.

Important

To deploy using Github Actions, you need to specify the SHUTTLE_TOKEN in the repository secrets along with any other environment variable you are going to use in your project.
You can add or remove variables in .github/workflows/deploy.yml file.
This template requires the following environment variables to be set in the repository secrets:\

SHUTTLE_TOKEN: The token to authenticate with the shuttle.rs server.\
DISCORD_TOKEN: The discord bot token.
Not specifying them in the repository secrets will result in a failed deployment.

Tip

To save your build hours, you may run the first deploy manually and then use the GitHub Actions to deploy the later changes.

Development

use general node workflow for development.

License

This project is licensed under the AGPL 3.0 License - see the LICENSE file for details

Author

Arnav Kumar (@arnav-kr)

A HTML to node macro powered by rstml.

html-node A HTML to node macro powered by rstml. Features Text escaping Pretty-printing NEW: type-safe elements and attributes! (example) Example let

6 Jul 28, 2023

🗽 Universal Node Package Manager

🗽 NY Universal Node Package Manager node • yarn • pnpm Features Universal - Picks the right package manager for you based on the lockfile in your fol

46 Oct 12, 2023

NodeCraft - Crafting seamless node operations for distributed systems

NodeCraft Crafting seamless node operations for distributed systems, which provides foundational traits for node identification and address resolution

3 Oct 9, 2023

Minimal, blazing fast Node.js script runner

nrr Minimal, blazing fast Node.js script runner. Why? nrr initializes and resolves scripts way faster than package managers. It achieves this by provi

3 Nov 17, 2023

Node.js tar binding

@napi-rs/tar Node.js tar binding https://docs.rs/tar/latest/tar/ Usage export class Entries { [Symbol.iterator](): IteratorEntry, void, void } exp

5 Dec 18, 2023

A simple Node.js library to convert raster images into svg

@neplex/vectorizer A simple Node.js library to convert raster images into svg using VTracer, with time complexity of O(n). Installation npm install @n

21 Dec 28, 2023

KAIVM is a multiplatform Command Line Interface (CLI) designed to simplify the process of downloading, managing, configuring, and running different versions of Shinkai Node

KAIVM - Shinkai Version Manager KAIVM is a multiplatform Command Line Interface (CLI) designed to simplify the process of downloading, managing, confi

7 May 1, 2024

A template for bootstrapping a Rust TUI application with tui-rs & crossterm

rust-tui-template A template for bootstrapping a Rust TUI application with tui-rs & crossterm. tui-rs The library is based on the principle of immedia

72 Dec 31, 2022

Self-contained template system with Handlebars and inline shell scripts

Handlematters Self-contained template system with Handlebars and inline shell scripts Introduction Handlematters is a template system that combines Ha