https://github.com/karmek-k/mijikasa

✂️ My very own link shortener (with a captcha)
https://github.com/karmek-k/mijikasa

link-shortener php php8 symfony

Last synced: about 2 months ago
JSON representation

✂️ My very own link shortener (with a captcha)

• Host: GitHub
• URL: https://github.com/karmek-k/mijikasa
• Owner: karmek-k
• License: agpl-3.0
• Created: 2021-03-10T13:58:28.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-21T19:17:46.000Z (almost 4 years ago)
• Last Synced: 2023-06-30T14:32:55.807Z (over 1 year ago)
• Topics: link-shortener, php, php8, symfony
• Language: PHP
• Homepage: https://mijikasa.herokuapp.com/
• Size: 287 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mijikasa

[![Build Status](https://travis-ci.com/karmek-k/mijikasa.svg?branch=master)](https://travis-ci.com/karmek-k/mijikasa)

This is a simple URL shortener. More features will be added soon!

**Mijikasa** (短さ, *shortness*) is a Japanese word

created from the adjective **mijikai** (短い, *short*)

## Features

- hCaptcha protection

- easy deployment on Heroku

## Installation

Mijikasa requires PHP 8 or greater.

You'll also need Composer and a database (I used PostgreSQL).

1. Install dependencies

`composer install`

2. Either create a `.env.local` file from `.env` template:

`cp .env .env.local`

or provide the environment variables manually.

**PLEASE** make sure that the `APP_ENV` variable

is set to either `dev` or `prod`!

Deploying on the `dev` environment poses a major security risk!

3. Now you can run the built-in PHP web server

`php -S localhost:8000 -t public`

or use a specialized one, such as nginx or Apache.

Make sure that you point it at the `public/` catalog!

## Tests

Running the test suite:

`php bin/phpunit`

hCaptcha is disabled in the `test` environment.

## License

Mijikasa is licensed under the `AGPL-3.0` license.