Skip to content

GooseGeeseJeez/PlagiaSight

Repository files navigation

Alt text

Static Badge GPLv3 License

🤔 Why PlagiaSight ?

Too many existing "plagiarism detection" tools just output a rather meaningless "plagiarism percentage" when the user provides them text.

We decided to adress this issue by ourselves, by creating an app that would provide comprehensive insights by analyzing given text(s) under different perspectives, hence the existence of PlagiaSight !

Our tool aims to keep results clear and interpretable (so : the tool won't draw definitive conclusions, but rather provide useful stats and guidance), allowing users to use their own critical thinking rather than letting the tool forcefully impose a judgment.

📽️ Application Demo

Alt text

💡 Do you want...

⬇️ To GET STARTED using PlagiaSight ?

Welcome ! Please follow these installation instructions :

MacOS / Linux

First, install and unzip our latest release.

Make sure that the file you just dowloaded, PlagiaSight_MacOS_Linux, is allowed to be executed as a program. If that's not the case, just right-click on the file and find the option to make the file executable.

Startup may be a bit slow the first time due to dependency installation. Run the executable file in your terminal if you feel like there's an issue with PlagiaSight's launch.

Windows

The installation process on Windows is not automated yet, but we're actively working on it.

Firstly, PlagiaSight's last version for Windows. In the folder you just unzipped, simply run PlagiaSight_Windows.bat in your terminal the first time (cmd/Powershell on Windows).

In other words, you open your cmd/Powershell and type the full path towards the path :

#should resemble something like this
path\to\plagiasight_folder\PlagiaSight_Windows.bat

Or just right-click on PlagiaSight_Windows.bat and click on "run in terminal". It can take up to 2-3 minutes for everything to be installed and for the app to start running the first time, depending on your internet connection.

If it fails, please retry while being in administrator mode.

The next time you'll want to run PlagiaSight, just run PlagiaSight_Windows.bat (not necessarily in your terminal), and it should launch in seconds :)

IMPORTANT : after you unzipped and executed the release you donwloaded for the first time, a folder named venv will appear. If you wish to move PlagiaSight's application folder afterwards, you MUST delete the venv folder before launching the application again !

If you have trouble executing any of these steps, don't hesitate to contact us !

🤝 To CONTRIBUTE to the developement of PlagiaSight ?

    We're always glad to see new contributors ! Here's a roadmap to get you started :

    1) MANIFESTO : The #1 thing you must read before contributing is our short manifesto.

    It contains the principles guiding PlagiaSight's developement, the structure of our codebase, and much more. In essence, it is the map that will guide you when you'll browse through the project's files.

    2) FIRST PULL REQUEST : Once you read and understood the manifesto, take a look at the codebase. Make a Pull Request or Open an Issue if you spot any areas for improvement.

    We encourage you to contribute, even if your Pull Request gets closed without being implemented : in PlagiaSight's case, it's better to try and fail to improve something rather than be scared to tell that something's wrong.

    3) OTHER DOCUMENTATION : Suggesting new features is often challenging, notably because predicting how useful a new feature will be is not an exact science. In order to maximize the chances to see your idea being approved, please check out the resources that inspired us first, and consider contributing there if it seems to align with the project's vision.

    But we can't stress enough the idea that, in order to propose new features that have a chance of being useful, you should take a peek at the documentation directly present in the project to understand all contributors' vision first. This will help ensure your proposals are cohesive with the project's goals.

    If you have questions or concerns regarding contributions, feel free to contact us !

💬 Contact the people behind the 1.0 version

About

Plagiarism detection made transparent.

Resources

License

Stars

Watchers

Forks

Contributors 5