/noclick.me

Mobile and web app to create new links in a noclick.me server.

Primary LanguageDartOtherNOASSERTION

noclick.me App SponsorGitHub SponsorsLiberapayPaypalBuy Me A CoffeePatreonFlattr

CI Coverage

Share links with more descriptive URLs!

This repository is the home of the mobile and web app to create new links in a noclick.me server.

License

The project is published under APGL (see LICENSE.md).

The main goal of choosing this license is to protect user's right. There is a second goal, for which there are not very good known licenses, which is to protect my ability (as developer behind the project) to sustain myself by finding ways to make a living with my work.

Because of this I decided to use a standard open source license and wirte a (non-legally binding) declaration of intent. Please read it if you want to make sure this software can stay alive and healthy (specially if you plan to offer this software as a service).

Contributing

This project is written in Flutter. Once you have a working Flutter SDK installed, you can build it with flutter build and try it out with flutter run.

Git Hooks

This repository provides some useful Git hooks to make sure new commits have some basic health.

The hooks are provided in the .githooks/ directory and can be easily used by configuring git to use this directory for hooks instead of the default .git/hooks/:

git config core.hooksPath .githooks

So far there is a hook to prevent commits with the WIP word in the message to be pushed, and one hook to run flutter analyze and flutter test before a new commit is created. The later can take some time, but it can be easily disabled temporarily by using git commit --no-verify if you are, for example, just changing the README file or amending a commit message.

Releasing

Please have a look at the release document.