revi-archive/xygt
1
0
Fork 0
mirror of https://github.com/jackeilles/xygt.git synced 2024-11-08 07:52:38 +01:00
Code Issues Projects Releases Packages Wiki Activity
xygt/README.md

1.3 KiB
Raw Blame History

xygt.png

This repository hosts all of the code for the file hosting site 'xygt.cc'.

About

xygt.cc is a simple, anonymous, temporary file-hosting service, designed with Python and Flask.

This uses MongoDB by default for the file index, user database, and the URL shortening DB, I'm not adding support for SQL.

Website

You can access the site on https://xygt.cc.

License

This project is licensed under the MIT License, which can be found LICENSE on the git repo. If you did not recieve a copy of the MIT License with this software, you can view a copy https://opensource.org/license/mit/.

Contributing

Refer to CONTRIBUTING

Forking

I don't mind if xygt is forked by anyone into a different project, all I ask is for some credit somewhere in the repo with a link back to here.

Thats it.

How to run?

  1. Clone the repository with git clone https://github.com/jackeilles/xygt.git
  2. Create a virtual environment in the repository folder python -m venv .venv
  3. Enter that venv with source .venv/bin/activate on Linux/MacOS or .venv/scripts/activate on Windows
  4. Install "requirements.txt" with pip install -r requirements.txt
  5. Run with whatever WSGI compatible runner you use, for example flask run