Giter Site home page Giter Site logo

patelheet30 / formulaforge Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 24 KB

A multipurpose bot allowing you to convert LaTeX Math Mode code into images alongside conversion of units.

Python 99.08% Dockerfile 0.61% Shell 0.31%
discord discordbot hikari-py latex math

formulaforge's Introduction

FormulaForge

You can invite the bot here

Description

This project was developed to test hikari-arc and its RESTClient. It converts LaTeX's Math Mode code into images using a custom API.

Table of Contents

Self-Host

To host locally, it is recommended to use VSCode. It comes with a built-in port-forwarder.

DISCLAIMER: This step-by-step process was written by a dude who has never used a Windows or Linux computer in his life. He develops on a Mac. If a command doesn't work, just ask ChatGPT or StackOverflow ๐Ÿ‘

  1. Start by creating a Discord App via the Developer's Portal
  2. This step if you're a Mac user:
  • In your terminal run /Applications/Python\ 3.10/Install\ Certificates.command
  1. Go to the Bot tab in your App profile and generate a new Bot token. Replace YOUR_TOKEN with your bot token in .env.example and remove .example.
  2. Create a Python Virtual Environment using python3 -m venv venv (py3 -m venv venv if you're on windows.) in the terminal and then run the command pip3 install -r requirements.txt
  3. Start the bot using python3 -m FormulaForge (py3 -m FormulaForge if on Windows). Start the API with uvicorn API.main:app --host 0.0.0.0 --port 80.
  4. Forward a public port with number 8080 and enter the forwarded address in your App's Interactions Endpoint URL (found in General Information). The image for the icon where you can start a public port in VSCode is found below: Port Forward Icon
  5. The bot should now work. If not, create an issue on Github or dm me on Discord: patelheet30

formulaforge's People

Contributors

patelheet30 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.