Guide Introduction

Welcome, this guide is going to create an application using the Sodacore framework as a demonstration of how to work with it.

Aim

Our project will be a to-do application that can be accessed via a web and Discord bot interface. We won't be implementing any kind of authentication or user management, but we will provide basic translation support for one other language (Portuguese) and initialise a Prisma project with SQLite to keep initial setup to a minimum.

This project has been based off of this demo project: Sodacore Demo. If you're not a guide kinda person, feel free to skip ahead and look at the code in the repository, this guide is purely to help you understand how to use the framework, notes and explanations will be provided throughout the guide to help you understand the code and how it works.

Topics covered

• The core framework.
• Directory structure.
• HTTP plugin.
• WebSocket plugin.
• Discord plugin.
• Prisma Plugin.
• I18n plugin.

Prerequisites

To follow this guide you should have a basic understanding of TypeScript and JavaScript, and some familiarity with Bun/Node.JS environments.

We would expect you have the following setup;

• A location for your project.
• Bun installed - Install.
• A Discord bot - Setup.
• An IDE/Code Editor - VSCode.

Ready?

If you're ready, press the next button below to continue.

• Install & Setup
• REST Controllers
• WebSocket Integration
• Discord Support
• Translations