nerdsplayingpnp-tud / magicaltavern-api Goto Github PK

This repository provides a JSON-based database handler, a RESTful API for use with magicaltavern-bot, your own implementations of a magicaltavern-web-endpoint, and last but not least a website for the magicaltavern service, with which users can enroll into Pen and Paper campaigns.

(back to top)

• Python 3.9
• Flask
• SQLAlchemy
• SQLite
• SQLAlchemy-serializer

(back to top)

To get a local development environment up and running, follow these steps.

• On Windows: Install Windows Subsystem for Linux. Use the WSL Terminal for this Project.

• python 3.9

• pip

  python -m ensurepip --upgrade

• venv

1. Clone the repo and cd into it.

   git clone https://github.com/bitfl0wer/magicaltavern-web.git
   cd ./magicaltavern-web

2. Create a venv and activate it.

   python3 -m venv ./venv venv
   source ./venv/bin/activate

3. Install requirements. Either:

   pip install -r requirements.txt

   or

   python -m pip install -r requirements.txt

4. Add an API key to the database. See the API documentation.

5. Create the file ${PROJECTDIR}/app_configurator.py using the following template:

   from flask import Flask
   
   
   def configure(app: Flask) -> Flask:
       app.config[
           "SECRET_KEY"
       ] = ""
       app.config["DISCORD_CLIENT_ID"] = 
       app.config["DISCORD_CLIENT_SECRET"] = ""
       app.config["DISCORD_REDIRECT_URI"] = "http://127.0.0.1:7777/callback"
       return app

   Fill in the value SECRET_KEY and add the ID and Client Secret of a Discord Application that you plan to use for the project.

6. Start the development environment with

   python main.py

(back to top)

WIP!

For more examples, please refer to the Documentation

(back to top)

• Website!
  • Campaign Enroll Feature
  • Discord OAuth Login
  • E-Mail and Password Login
• 1-Factor Email Authentication

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the AGPL v3.0 License. See LICENSE.txt for more information.

(back to top)

Nerds Playing PnP - [email protected]

Project Link: https://github.com/bitfl0wer/magicaltavern-web

(back to top)

• Fugi
  • Added Dockerfile and corresponding configuration for easy Docker Deploy functionality! Also reviewed my code on the big rewrite :)
• SaltyOne
  • Is currently working on all website related issues, and is a second project maintainer. ❤️
• Casey
  • Reviewed my pull request and suggested changes! Thanks, casey! :>

(back to top)