🐸 Archy 🐸

Open source serverless bot!

📖 Prerequisites

This project is designed to run on Google Cloud with a Compute Engine instance and many cloud functions.

☁ Global architecture

This project is designed to run on Google Cloud.

The "main node" is a Compute Engine running a Docker container with Python code. This node is here to parse every discord message to find commands.

Every command is running inside Cloud Functions. This allows us to develop those in any supported languages.

Functions can trigger other functions using Pub/Sub.

All data is stored in Firestore.

In addition to this, we also have a web page developed in Angular on Firebase Hosting

🖥️ Local development

• Bot and commands -> README
• Web -> README

🤝 Contributing

We encourage you to contribute to Archy! Come to our discord server to talk about your ideas and changes!

• Note that all development is done in English, please do your best to code, commit and comment issues/PR in English.

Feel free to submit PRs for small issues. For large issues or features, open an issue first.

(Disclaimer: We took the contribution work flow from fireship.io)

Option 1 - Simple Typo Fixes

For small issues, like a typo or broken link, use Github's inline file editor or web editor (open by pressing . in your fork's code tab) to make the fix and submit a pull request.

Option 2 - Work on your own Fork

For more complex contributions, like guest posts and new features, you should work on the project on your local system.

First, fork this repo on GitHub.

git clone <your-forked-repo>

git checkout -b my-fix
# fix some code...

git commit -m "fix: corrected a typo"
git push origin my-fix