florgon/cc-api

Link shortening API written in Flask using Florgon Ecosystem (APIs).

cc-api's Issues

Finish views counter...

Change license from MIT to AGPLv3+

AGPLv3+ requires giving a copy of program through network, so I'm planning to implement this API method. /v1/source for example. It will give link to github repo and link to direct downloading of cc-api code archive.

API returns wrong link to stats and qr

Flask's url_for with _external=True builds url using internal docker network and API gives wrong link:

"_links": {
        "qr": {
          "href": "https://florgon-cc-api/v1/urls/bdWxN2/qr"
        },
        "stats": {
          "href": "https://florgon-cc-api/v1/urls/bdWxN2/stats"
        }
      }

The links should be https://api-cc.florgon.com/v1/urls/xxxxxx/qr and https://api-cc.florgon.com/v1/urls/xxxxxx/stats

Remove redundant config hierarchy in source code.

Remove Config hierarchy to plain.

[FEATURE] Add support for text pasting.

• Add model for text and migration. (@stepan-zubkov)
• Add new views for working with text pastes (@kirillzhosul)
• Refactor system for both urls and pastes (@kirillzhosul)

Create full documentation.

I prefer docs in markdown format, so I want to use it for cc-api docs.

• Rewrite README
• • Add information about license
• • Add contribution mini-guide
• • Rewrite deploy guide
• • Add logo (optional)
• • Add information about clients (cc-cli, cc-web)
• Add API docs in docs/ folder
• • Describe all url/ methods
• • Describe all paste/ methods
• • Add examples (curl + maybe python)
• • Describe Url and Paste models.
• • Mini-guide for contributors, that describes code structure and code style

All docs should be initially written in English and later translated to Russian. Maybe other languages, if I find translators.

Add url views by dates

Fix typo in license notice in every file

License notice, that placed at start of every file:

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

You should replace "GNU General Public License" in this notice in every file by "GNU Affero General Public License"

[FEATURE] Add users system from SSO.

Add `exclude_expired` и `exclude_deleted` params to urls and pastes list

Add programming languages support for pastes

Add PasteUrl.lang attribute, that contains programming language of paste. Defaults to plain.

Add design (HTML/Bootstrap)

QR-Code for url

404 Handler

Handler for 404 http code returning json response

Try create simple Android client.

Create simple Android client that requests API to shorten given links.

[FEATURE] Track IPs, User Agents after URL open.

Create form for URL shortening.

Mixin for database tables

It should contains id, created_at fields

Migrate to FastAPI.

[FEATURE] Add caching && rate limiting with `redis`

[FEATURE] Add Gatey SDK.

Add pytest testing to github workflow

[FEATURE] Do not delete URLs from DBMS, just mark them as deleted.

Support for mailto: and tel: links

Move views to `/api/`