Purl

Purl (Petite URL) is an open source project with the goal of providing you with your own private URL shortener!

This project was my first symfony project, keep in mind that there are a lot of improvements that could be made. The point of this project was to learn symfony, and I happened to need a URL shortener.

You are welcome to send pull requests if you like!

Development

Check the docker guide if you want to use the docker images, if you use your own workflow, continue reading!

Install

Install the required packages.

composer install

Create the database scheme, add an admin, install assets:

bin/console doctrine:schema:create
bin/console fos:user:create admin [email protected] admin
bin/console fos:user:promote admin ROLE_ADMIN
bin/console assets:install

You will be asked to enter some parameters, adjust them to your own needs.

Once done, you should be ready to go. You can access the admin on /admin and log in using your previously created admin user.

Testing

Create a database named test and make sure the dev mysql user has access to it. Then create the schema for the test environment:

bin/console doctrine:schema:create -e test

Once the database is set up, you simply run phpunit:

vendor/bin/phpunit

REST API

REST API docs can be found here

Credits

• Background image by Roman Pohorecki (source)