Merge branch 'feat/tutorial' of https://github.com/sern-handler/website into feat/tutorial

This commit is contained in:
2023-09-05 21:48:29 +02:00
3 changed files with 73 additions and 0 deletions

View File

@@ -0,0 +1,36 @@
# Guide Overview
Welcome to the sern Discord Bot Development Guide! 🚀
## What You'll Learn
In this comprehensive guide, we'll take you on a journey from the basics to the advanced concepts of creating and deploying your own Discord bot using the sern framework. Whether you're a beginner or have some coding experience, we've designed this guide to be inclusive and accessible to all.
## Guide Structure
Our guide is structured to take you step by step through the process of building a Discord bot with sern. Here's an overview of what you can expect:
- **Who are we?** Meet the sern team behind sern.
- **What is sern and what problems does it solve?**
Understand why sern, what is it and what does it solve.
- **Preparing** Set up your development environment.
- **Setting up the project** Learn about libraries and tools like @sern/handler and discord.js.
- **Setting Up the Bot** Register your bot, obtain necessary credentials, and set it up.
- **sern Overview** Dive into the core concepts of sern and its components.
- **Example Projects** Build practical Discord bots with sern.
- **Integration with Databases** Learn what is a database, which is the right one for you. And how to use them in your bot.
- **Ship Your Code To GitHub** Learn about Git, GitHub CLI, and version control systems & how to use them.
- **Deploy** Discover hosting options, scaling with AWS Fargate, and more.
- **Other Steps** Explore additional topics like comparing sern to other solutions and planning for future growth.
- **Conclusion** Reflect on what you've learned and your next steps in Discord bot development and sern.
We're excited to embark on this journey with you. Each section is designed to build upon the previous one, so feel free to follow along step by step or jump to the topics that interest you the most. By the end of this guide, you'll have the skills and knowledge to create, deploy, and manage your own Discord bot using sern.

View File

@@ -0,0 +1,19 @@
# What is sern?
We're a discord bot framework. The lack of tooling in the discord.js community is apparent, and is also monolithic. You can make botseasily with our suite of tools, and with conciseness. We're also a community. PLS join [here](https://sern.dev/discord) 😼.
### Problem
- **no beginner friendly handler**
- **bad practices in discord.js guide**
- **lack of wholesome community in discord.js**
- **lack of modularity**
sern tries to solve all these problems. This tutorial is for anyone and everyone, beginners and advanced a like.
## Solution
- our handlers are modular and efficient.
- from my personal experience, the community feels pretentious and mean.
- discord.js discord chat feels pretentious and unwelcome to beginners.
- From community plugins to container, swap out tooling and things with ease.

View File

@@ -0,0 +1,18 @@
A package manager is like a helper for your programs. It brings all the tools for your projects and makes sure they fit and work well together. It's like having someone organize things so you can work without problems.
Some examples are
- [npm](https://www.npmjs.com)
- [Yarn](https://yarnpkg.com)
- [pnpm](https://pnpm.io/)
For this tutorial, we'll be using **[Yarn](https://yarnpkg.com)**. It's made by Facebook.
**Advantages of Yarn:**
1. **Performance:** Yarn is fast enough and has efficient dependency management.
2. **Lockfile:** Yarn's `yarn.lock` file ensures deterministic builds, crucial for collaboration.
4. **Offline Mode:** Yarn offers a reliable offline mode, ideal for environments with limited internet access.
5. **Selective Installs:** You can choose to install specific packages without affecting the entire dependency tree.
6. **Plug-n-play:** Yarn 2 introduces "plug-n-play" (PnP), reducing disk space usage.
**Choice of Package Manager:**
For this tutorial, we will use Yarn as the package manager. Yarn offers several advantages like above and it's a great choice to streamline development and ensure consistency, especially in collaborative environments. Both npm and Yarn are excellent package managers, and your choice will depend on your specific project requirements and personal preferences. Regardless of which package manager you choose, make sure to document your choice and ensure that your team members are on the same page to avoid potential issues during development.