eddiejaoude/stargate

Discord bot using Stargate Serverless (Cassandra DB)

🤖 Discord bot using Stargate 🤖

Stargate is a data gateway deployed between client applications and a database. It's built with extensibility as a first-class citizen and makes it easy to use a database for any application workload by adding plugin support for new APIs, data types, and access methods.

YouTube video of Stargate

Technologies Used

• DiscordJS with Typescript
• Stargate - sign up with GitHub login for FREE on DataStax Stargate and get a NoSQL DB up in minutes with approximately 30 million reads, 5 million writes, and 40GB of storage per month for free (Docker container also available) - watch a 1min video by me on how to create and retrieve data

GitHub actions

Tag	Name	Triggers	Results
	Change Log	Pushes to main branch	Updates release tag
	CodeQL Status	Pushes & Pull Request	Checkout repository, installs dependencies, build files, perform analysis
	Docker Publish Status	Published releases	build, test, push to registory, deploy
	Docs status	Pushes to doc/ repository	Checkout source files, build doc files, deploy
	Labels status	Pushes to doc/labels.json	checkout source files, install deps, import labels
	Node CI status	Pushes & Pull Request	Checkout source files, install dependencies, lint source files, verify build, run tests
	Stale issues and PRs status	Iterval of every 30 minutes	Updates issue / PR messages & labels

Screenshot

Quickstart

1. Fork the project
2. Clone project using git clone [email protected]:<YOUR-USERNAME>/stargate.git
3. Navigate into the project using cd stargate
4. Run cp .env.example .env
5. Add the respective env-vars to the .env file
   • generating Discord bot token
   • making AUTH token for Stargate
6. Install dependencies npm install
7. Run the docker container for stargate (not this repo) with docker-compose up

Docs

• Project board v0.1 of to do, in progress, done

Full docs deployed to https://eddiejaoude.github.io/stargate/ and available in the repo at docs/README.adoc

Building the docs

Install AsciiDoctor and CodeRay.

npm run docs

Phase 1

Goals

A video tutorial on how to use Stargate serverless

Features:

• CRUD usage of Stargate
• Discord Bot (bio, social links, timezone)
• 5-10mins edited video

Challenges

• Cassandra is associated with being "scary"
• People using what they are used to even if the wrong tool for the job
• People use what they hear most for example Mongo or an equivalent in the frontend space React

Storytelling

• That it is not any more difficult than similar alternatives
• Simple and quick to use at hackathons and build prototypes
• Scalable so that enterprise projects can use it too
• Serverless is an affordable option for everyone (also has a free tier)
• Stargate is open source and can grow and scale with the project

Problem

• Awareness of Stargate
• Cassandra scares people, usually perceived as being "difficult" or "hard"
• Educating people on the benefits of using Stargate

Solution

• Short / concise video (5-10mins)
• 1min social teaser video
• Include what is Stargate serverless
• Build a simple Discord bot, to get/set user details and read/write to DB using Stargate serverless (bio, socials)

Vision

• Easily digestible content
• More projects on Github using Stargate
• Clear and engaging message
• Lowering the barrier to entry
• Low cost of usage
• Community excited about it

Impact

• Evergreen content
• Searchable content
• Concise / digestible content for everyone to get started
• Community building their own projects with Stargate serverless

Made with ❤️ by an awesome open source community!

stargate's Issues

Discord Bot Feature: Command to Add Timezone

Add Timezone

/timezone PST
/timezone EST etc.

Add introduction video of Stargate in readme

Stargate introduction

We could move this repo to EddieHub Organisation

We could move this repository to EddieHub Organisation (within Github) to make the project visible to a wider crowd.

Numbered list of Quickstart in README.md does not count correctly.

Description.

The Numbered list of Quickstart at the bottom of READ.md is not correct.

• Quickstart

It should appear as below,

6. install dependencies npm install
7. install husky helpers npm run prepare

Update readme

Adding info about stargate

Create Changelog from commits

When a release is created, a changelog file could be added to the code base since the previous release

Add feature of FAQ in the bot

If users have questions that are frequently asked so for that we can create FAQs, folks can use the FAQ command and the bot will show frequently asked questions answere

commit messages to be linted with husky

Documentation https://commitlint.js.org/#/guides-local-setup

Add some Linter checks to the bot

Suggestion: As the projects proceeds we can add some linter checks to the bot so as to reduce errors and improve the overall quality of code

You can read more about Linter here
What is Linter

EddieBotMap

Creating a map which is just similar to Snapchat and we can add events or hackathons to the Map so that folks can stay updated where the hackathons and events are taking place on the map

Technologies Used!

Create a .md file listing the technologies we are using
For example - typescript

Suggestion: A ordered List would be a good way to list them.
Feel free to ask any doubts :)

Info about stargate on social media platforms

If we can share deep info about what actually stargate is on social media platforms then we can get some great suggestions from others as well which can be helpful.

Agile story point labels

Involving everyone (developers, designers, testers, deployers... everyone) on the team is key. Each team member brings a different perspective on the product and the work required to deliver a user story. For example, if product management wants to do something that seems simple, like support a new web browser, development and QA need to weigh in because their experience has taught them what dragons may be lurking beneath the surface.

https://www.atlassian.com/agile/project-management/estimation

Numbers needed are from Fibonacci sequence
https://en.wikipedia.org/wiki/Fibonacci_number

{
    "name": "🔢 points: 1",
    "color": "62A1A6"
}

https://github.com/eddiejaoude/stargate/blob/main/docs/labels.json

Labels to use open source standard

To facilitate the community in finding ways to contribute that match their experiences and skillsets, we have developed a comprehensive system for labelling issues and PRs. This is an introduction to this standard labelling scheme.

Labels consist of three fields, viz. name, description and color. Label names should have a consistent format to aid both filtering within the github UI as well as scanning visually through the list. The following format is the most suited to this task (where ⎵ denotes a single space):

<emoji>⎵<category>:⎵<name>

Using the label convention from https://opensource.creativecommons.org/contributing-code/repo-labels/

Adding Stale Bot

I would like to add a stale bot that Automatically close stale Issues and Pull Requests that tend to accumulate during a project.

Feat: Make this in python too

Denise is a python developer too.
Maybe this can be synced with more Data-intensive commands(python is really great at that) revolving around their niche?

This can be made in a new branch : )

Moreover, we can make Python Bots really fast.

Discord Bot Feature: Command to Add Social Links

Set Social Links
/social github = "https://github.com/yalematta"
/social twitter = "https://twitter.com/yalematta"

Addition of relevant data flow diagrams on README.md using Mermaid

A data flow diagram detailing the state of data flow between the user, Stargate and Cassandra, by making use of Mermaid.

Dockerise app

Dockerising the app is great for

• Build a Docker package
• Publish to GitHub Registry
• Github to run both steps

Link to Stargate

Since a lot of folks might not be aware about Stargate, add a link to the repo in the README file.

Feat. Create project goal

Discuss with the community the goal for the Discord bot

Live Stream: https://www.youtube.com/watch?v=pekHBfYd1-Q

Notes from Adobe XD to the README for transparency

• Include this in the README
• Also have a text version for the most important parts

Add Code of Conduct

I would like to add a code of conduct file as code of conduct is a necessary file which the contributors need to follow so that everyone follows a decorum.

Docker package to use same version number as Release

Currently the release version and the docker versions do not match

https://github.com/users/eddiejaoude/packages/container/stargate/versions

https://github.com/eddiejaoude/stargate/releases

Create profile picture for stargate bot

Discord Bot Feature: Command to Add Bio / Get Bio

We might need a command for the Discord bot to add bio and retrieve bio.

Set Bio

/bio "I am a Software Engineer. I love eating and computers."

Retrieve Bio of someone by tagging them in the command

/bio @eddiejaoude

Add Social Links

person> /bio add github https://github.com/yalematta
bot> added bio

Set Up Contributor Tooling

Let's add tooling such as eslint, husky, prettier to ensure code standards as we accept contributions from members.

Here's my default TypeScript tooling: https://github.com/nhcarrigan/code-snippets/tree/main/node-ts-config

Feat: Create GitHub Action

Description

It would be really helpful to add a GitHub action that will cover the following:

• Check lint issues
• Help with updating forked repo

Add CONTRIBUTING.md and CODE OF CONDUCT

Adding contributing.md to help potential project contributors with a short guide to how they can help with your project

Custom Introduction video for Stargate

We can create a custom video for Stargate to help people get a better idea of Stargate and what this project is about:

1. Adding custom info about Stargate
2. Adding necessary details about the project
3. Maybe we can use some animations just to make it a little bit fun

Using Conventional Commits

Conventional Commits

make the intro video in the Readme.md load on a different tab

making the intro video in the readme load on a different tab would be great !!! because when you click on the video link it takes you out of github to youtube!

Live stream poker planning for story points on issues.

Description

I think there should be a live stream planning the story points.

Join Eddie's discord community here

Add a PRIVACY.md privacy policy

Privacy Policy is required for all Discord bots. We should add a basic one (refer to Vyvy-vi's links below).

CI Actions badges

Badges in README for

• import labels
• node ci
• publish docker image

https://github.com/eddiejaoude/stargate/tree/main/.github/workflows

Example badge

[![GitHub Super-Linter](https://github.com/<OWNER>/<REPOSITORY>/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)

Use SSH in the quickstart docs

Description

Instead of using HTTPS after forking, it would be recommended to use SSH. A lot more secure and good way to go about things for contributors.

Screenshots

N/A

Additional Context

Change clone project git clone https://github.com/<YOUR-USERNAME>/stargate to clone project git clone [email protected]:<YOUR-USERNAME>/stargate.git in the README.md under QuickStart

Join Eddie's discord community here

Add a privacy policy

Discord bots requires privacy policy when it uses the API

Build docs to GitHub Pages with AsciiDoctor

Description

To view the docs on GitHub Pages with be better DX. This can include diagrams and generate a PDF later as required

https://asciidoctor.org

Deploy to Docker container to Kubernetes cluster

Docker containers are build on a GitHub release with a GitHub Action, next step is to deploy these to our Kubernetes cluster with a GitHub Action

• Create a Kubernetes secret for the Discord token via environment variable (Sid)
• Hello world Discord Bot (Eddie)
• With test command to get app version (Eddie)
• Docker environment to accept Discord Token docker run -e DISCORD_BOT_TOKEN=<token> -p 3000:3000 --name stargatebot -d ghcr.io/eddiejaoude/stargate:latest (Eddie)

This will be done on a live stream on Monday 15th at 5pm UK time in collaboration with Sid

Build version number included in docs

It would be great to include the build number in the docs, so if someone has an issue with the docs, we know exactly what version they are looking at - it could be out of date

• Asciidoctor can have a custom footer
• On GitHub Action replace {{ VERSION }} in the footer with the package.json version
• When building the docs include the custom footer

FEAT: Add a .env file beforehand

Description-

Discord bot API token and other API keys should be added in a .env beforehand(rather than hard-coding while testing).

Q) But Why?:

Ans- To prevent accidental pushing of keys

*this issue is on a lighter note:
CONTEXT: https://discord.com/channels/699608417039286293/801475116668026951/814615707773435945

Create CODE_OF_CONDUCT.md

Created during live stream: https://www.youtube.com/watch?v=pekHBfYd1-Q

Info about Stargate

We can add more information about Stargate for other people to understand better!

Which Technology is being used?

• Details of tech which we are going to use in discord bot.

Bio Feature for this bot

We can modify the feature of retrieving the bio of other person without actually tagging the person.

Add Issue and PR templates

We should implement issue templates and a pull request template.

We can consider using the Creative Commons Open Source Labels: https://opensource.creativecommons.org/contributing-code/repo-labels/

Add Contributing.md

We can have these links for the following in CONTRIBUTION.md file
1.We can add Github documentation links for
i). Getting started with Git and GitHub
ii). Forking a Repo
iiI). Cloning a Repo
iv). How to create a Pull Request
2.Also, we can give the links for git installation
3.We can also add Style Guides for Git Commit Messages
These things will help people new to opensource understand clearly on how to create an issue and how to create a PR.

Integrating discord with the channel's Twitter account

We can integrate the discord bot with the channel's Twitter account so that nobody misses on any update
Feel free to ask any doubts :)

add stargate link address to the read me

I think adding link to the landing page of stargate to the readme would be great

Workflows - CI for GitHub Actions

As we establish the code, we'll want to enable CI such as verifying the lint, build, and tests all pass.

Enable Dependabot security updates: https://github.com/nhcarrigan/code-snippets/blob/main/optional-workflows/dependabot.yml

Enable Node.js CI: https://github.com/nhcarrigan/code-snippets/blob/main/optional-workflows/node-ci.yml