Skip to content

azerdict/api

Repository files navigation

Build Status

azerdict.com is an open-source free dictionary service. This is the repository of azerdict API that powers the website and mobile apps. It is built on top of Symfony.

Installation

Requirements

First, clone the repository and install dependencies via composer:

git clone [email protected]:azerdict/api.git
cd api/
composer install

To create local database and populate it with dummy data run the following commands:

php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate --no-interaction
php bin/console doctrine:fixtures:load --no-interaction

Run server:

php bin/console server:run

Now you are ready to test it with your favorite browser or API development client (ex: Postman, Insomnia, etc.) by navigating localhost:8000

Endpoints

  • GET /dictionary/english-azerbaijani with term query param.

Testing

Testing is done with PHPUnit. To test the code simply run php bin/phpunit

License

azerdict is free and released under Mozilla Public License 2.0