Welcome to the Official documentation of Aston Unofficial (ironic I know). Get started with the Installation and Quickstart guides.
This project depends on:
you can find the documentation using the above links.
We recommend using the latest version of Python3. This project was created using Python3.8
These dependancies will be installed automatically when using Docker.
$ pip3 install -r requirements.txt
Flask
ItsDangerous
FlaskMail
Gunicorn
FlaskWTF
Discord
To run this project, you must have Docker and Docker-compose installed. These services handle running the Database, Flask, and Discord bot. Although it is possible to run snippets of this project individually, you will not be able to use the entire project without the use of docker-compose.
You may follow the docker installation guide for more information about this topic.
Once all of these dependancies have been installed, you may follow the Quickstart guide for information about building and developing the project.
The MIT License
Copyright (c) 2020 Harry
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.