GithubHelp home page GithubHelp logo

giampaolofalqui / cj Goto Github PK

View Code? Open in Web Editor NEW

This project forked from southclaws/cj

0.0 3.0 0.0 6.5 MB

CJ is a Discord bot that verifies SA:MP forum accounts and performs other tasks if you ask nicely.

License: GNU General Public License v3.0

Dockerfile 0.29% Go 98.95% Makefile 0.77%

cj's Introduction

SA:MP Forum Discord Bot

Travis

CJ

CJ verifies SA:MP forum accounts and performs other tasks if you ask nicely.

Not really in development and not accepting new features. I fix bugs from time to time but it serves it purpose as a verification tool and basic forum interface.

Development

This project is open to anyone who wants to contribute, large or small! Whether you noticed a typo or want to add a whole new feature, go for it!

Large additions should be discussed in issues or on Discord first. If you're new to Golang, ask me on Discord for where to start and you can use CJ as a starting point for a contribution.

Testing/Workflow

To run the app, you need:

  • A Discord server to test - you can't use the SA:MP Discord to do tests
  • Go 1.11 - no guarantees on older versions

If you don't own/admin a Discord server, creating one is simple, you can do it from the same menu you join discord servers from.

Running with a database

If you want to develop features that require persisting data, spin up a MongoDB database. If you have Docker installed, this is as simple as running make mongodb which will start a MongoDB container with a user root that has no password. If you don't have Docker, you'll need to install MongoDB onto your system..

Running without a database

If you don't need a database for your feature, just add NO_DATABSE=true to .env.

Finally, the application requires some configuration. Copy the example.env to .env and modify it to use your token and various IDs. Depending on what you're working on, some values won't be necessary. For example, unless you're actually working on the verification system, you don't need to set the verified role ID.

Now you can build and run the application with make local.

cj's People

Contributors

agraber avatar amyrahmady avatar bigeti avatar bios-marcel avatar dayvison avatar dependabot[bot] avatar gigabitzz avatar hual avatar southclaws avatar sreyas-sreelal avatar sunehildeep avatar thecodeah avatar tommyb123 avatar wopss avatar

Watchers

 avatar  avatar  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.