hydractify / website

The website for our organisation.

Introduction

This is a Discord application for experimenting ideas on and serve our community needs.

Requirements

• Rust
• PostgreSQL

Getting started

Firstly what you want to do is clone this repository:

git clone https://github.com/Hydractify/hydractify.git

From here you will configure the application with config.toml, you can use config.example.toml as a reference. Here you will set:

• The application's token (token);
• The database URL (database_url), i.e. postgres://username:password@localhost/database_name;
• Module configuration.

Once that's done, you need to install diesel_cli for automatically generating typings and running our SQL to make sure all tables are configured. You can install it through cargo:

cargo install diesel_cli --no-default-features --features postgres

Once that's done, ensure it's binary in your $PATH then run:

diesel migration run

Now you can just run the application! If you're not familiar with Rust, you can run it through your terminal with:

cargo run

Modules

Self Role

This module is configured via [self_roles] in config.toml, which has two fields:

1. enabled
   • Whether the module is enabled or not. The commands are still registered, maybe they shouldn't.
2. channel_id
   • The ID of the channel where the self role message should be deployed.

When enabled and the message is deployed then when a Discord user interacts with the module they will have that certain role added to them or removed.

Slash commands

To configure and manage the message with the self assignable roles you must use the /selfrole slash commands, these being:

1. /selfrole show
   • Lists the registered self assignable roles.
2. /selfrole deploy
   • Deploys the message with the self assignable roles, optionally receiving a message ID to edit an existing one.
3. /selfrole cleanup
   • Removes from the list all roles that have been deleted.
4. /selfrole remove
   • Removes a specific role from the self assignable role list.
5. /selfrole add
   • Adds a specific role into the self assignable role list.

Starboard

This module is configured via [starboard] in config.toml, which has four fields:

1. enabled
   • Whether the module is enabled or not.
2. channel
   • The channel that starboard messages should go to.
3. emojis
   • An array containing the emotes that trigger a starboard message, these can be an UTF-8 character like ⭐ or a custom emote like <a:a_kirbyStar:894087344909606912>.
4. threshold
   • How many emotes are needed to trigger a starboard message.

Special thanks

This implementation is heavily based off of etternabot, it was a great starting point for me to understand how poise and serenity work!

website's Issues

Add footer contact details

Information

This footer section should be "grid" (actual grid or flex) based, having three columns:

1. Contact information (Left corner)
   • E-mail
   • Discord server (hydractify.org/discord)
   • Twitter
2. Empty column
   • "Empty" for potential eventual usage. Currently existing to create a wide gap between the leftmost and rightmost column.
3. Relevant links (Right corner)
   • GitHub
   • Patreon
   • Steam

All icons should already exist with antd, so you can just use that.

Stylize navbar with the organization's logo

Information

Add the logo to the navbar and adequately stylize it if needed.

Reducing the website's navbar height might be needed. There is too much space between the text and the selection border and top of the page.

Create a section showcasing our projects

Information

Currently the only project needed to showcase is Kanna Kobayashi but make sure to build it to be able to create dynamically another one (perhaps an arrow that you may click to lead/scroll to the second one).

The project's logo, name, relevant links (GitHub, Discord) and a brief description may be added. A foreground would also be appreciated for extra style.

Data

The information used in this section should be within a JSON to be created dynamically. The information should be as follows:

{
  "Kanna Kobayashi": {
    "foreground": "picture",  // Optional. Default: None
    "logo": "https://cdn.discordapp.com/avatars/297459926505095180/b8725a320e6c8e20774d60d818d7ab96.webp?size=2048",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus laoreet eros dui, a porttitor lorem consequat vitae. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed faucibus, diam in pellentesque finibus, dui neque efficitur urna, non bibendum nisl elit ultrices nisl. Curabitur aliquam libero leo, vel lobortis nibh luctus eget. Duis feugiat purus in diam fermentum, ut placerat ligula ultrices. Sed mi nulla, molestie at urna ac, interdum tristique tellus. Nulla facilisi. Duis malesuada a mi non convallis. Curabitur convallis libero eget lectus faucibus mollis. Fusce malesuada condimentum risus luctus feugiat. Vivamus ullamcorper molestie tincidunt. Nulla urna libero, sodales vel.",
    "links": { // Optional. Default: None
      "GitHub": "https://github.com/Hydractify/kanna_kobayashi"
    },
    "redirect": "https://github.com/Hydractify/kanna_kobayashi" // Where you get redirected to after clicking the project's title. Optional. Default: None
  }
}

Create missing components of the community profile

Summary

This purpose of this task is to finish/comply with all the missing components for the repository's community profile.

Technical specifications

The following items need to be created:

• Code of conduct;
• Contributing;
• License.

All of which should reside within the .github folder, located in the root of the project.

Create a staff section

Information

Build a static JSON with staff data and dynamically showcase them based on such.

The structure should be:

{
  "267727230296129536": { // User's ID
    "username": "wizardlink",
    "avatarURL": "https://cdn.discordapp.com/avatars/267727230296129536/36b56e419f2d3818ecafdd881ca4d762.webp?size=2048"
    "role": "Founder", // Optional. Default: "Staff"
    "accent": "#ff0000" // Border of the avatar frame. Optional. Default: "#f13030",
    "icon": "DownCircleOutlined" // Optional. Default: "SmileOutlined"
  }
}

Collect reviews from patreons and showcase in a section.

Information

Showcase the patreon's username and avatar if allowed, otherwise, preserve anonymity.

Of course, also showcase it's review/opinion.

Make an about us section in the top

Information

A section detailing the purpose and intent of the organization as well as our presence throughout the years.

Pictures/vectors are not necessary, but welcomed.

Mockup

The first version of the about us will be used as a foundation (mockup) so other contributors build upon. Where once we decide the best wording/approach, then the issue moves on to be finished.