node-shuttle
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.tomltoshuttle/Secrets.tomland 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.jsoncontains theshuttle: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_TOKENin 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.ymlfile.
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