Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 3.38 KB

README.md

File metadata and controls

41 lines (29 loc) · 3.38 KB
Raw

brainlets

brainlets.moe is a simple website that features a few tools for the mobile game known as Girls' Frontline.

Overview

The key draw of this project is the damage simulator, a tool used by thousands of players across the world. The damage simulator aims to be user-friendly and up to date, all while attempting to be as accurate as a web-based simulator can be. As there are many other popular websites that feature other useful tools and guides for the game, the sim will remain the focus of project brainlets, as opposed to the development of other tools/pages.

This project was started on a whim by someone with no development experience. As such, there is a LOT of room for improvement. The technologies used were all chosen arbitrarily, as was the general design of the sim. Any and all feedback is welcome, and highly appreciated.

Contributing

Simply fork this repo, make changes, and submit a pull request. Just please be sure to test any changes you make. Feel free to reach out to me with any questions you may have.

To get started:

  1. Fork this repo
  2. Have python3 installed (version 3.3+ preferred)
  3. Create a virtual environment and activate it
  4. Install project dependencies using pip install -r requirements.txt
  5. Make a copy of brainlets/brainlets/sample_settings.py named settings.py
  6. Use python manage.py collectstatic (manage.py is found in brainlets/)
  7. Use python manage.py runserver to start the dev server (defaults to 127.0.0.1:8000)

Local deployment via Docker

The build instructions inside the project's Dockerfile make it fit for deployment on your local machine. If you intend to serve the project on a publicly accessible server, you should at least set up a reverse proxy, e.g. nginx or traefik.

  1. Install Docker.
    • Most unixoids will have a docker.io and docker-compose package hosted in one of their repositories. See also here. To get the guaranteed latest version of compose, see here.
    • Windows Installer. Note the system requirements, and the alternative Docker Toolbox download for systems unsupported by Docker Desktop.
    • OSX installer. Note the system requirements, and the alternative Docker Toolbox download for systems unsupported by Docker Desktop.
  2. Open a command line interface and navigate to the root of this project, containing the docker-compose.yml and Dockerfile files.
  3. Run docker-compose up to start the service, and navigate to http://localhost:8000.
    • docker-compose up -d will run the service in the background.
    • The service debug flag is enabled and service and static files are served on a bare gunicorn process, do NOT expose the process to the internet.

License

This project is under the GNU General Public License v3.