README.md

Node.js on shuttle.dev Template

This Template is a starting point for creating a Node.js project on the shuttle.dev. 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

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

• rename Secrets.example.toml to Secrets.toml and put your environment variables there. Those will be deployed to the shuttle.dev project.

• deploy the project

  npm run deploy

Deploy via GitHub Actions

The template comes with a GitHub Actions workflow that deploys the project to shuttle.dev on every push to the main branch.

Important

To enable the workflow, you need to add the SHUTTLE_TOKEN and SHUTTLE_PROJECT_ID to the repository secrets.

Development

use general node workflow for development.

Adding to an existing project

Copy the following files to your project:

• Shuttle.toml (rename names according to your project, include any additions assets here)
• Cargo.toml (rename names according to your project)
• src/main.rs
• shuttle_run.sh
• shuttle_setup_container.sh
• add shuttle related entries to .gitignore
• (optional) Secrets.example.toml (rename to Secrets.toml and add your environment variables)
• (optional) .github/workflows/deploy.yml (if you want to deploy via GitHub Actions)

deploy the project using npm run deploy

License

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

Author

Arnav Kumar (@arnav-kr)