Tranga-Website/README.md
2023-09-03 18:45:58 +02:00

3.5 KiB


Tranga-Website

Automatic Manga and Metadata downloader

This is the Website for Tranga (API)

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments

About The Project

Tranga-Website is the Web-frontend to Tranga (the API). It displays information aquired from Tranga and can create Jobs (Manga-Downloads).

What this does do (and nothing else)

This repo makes HTTP-requests to the Tranga-API to display it's present configuration.

Built With

  • nginx
  • HTML, CSS, and barebones Javascript
  • 💙 Blåhaj 🦈

(back to top)

Getting Started

There is a single release:

Docker

Download docker-compose.yaml and configure to your needs. The docker-compose also includes Tranga as backend. For its configuration refer to the repo README.

Roadmap

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

(back to top)

Contributing

The following is copy & pasted:

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)

License

Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)