Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.69 KB

readme.md

File metadata and controls

51 lines (40 loc) · 1.69 KB
Raw

Handwerker

Build Status

This is a RESTful API for job posting application. It includes authentication, authorization, internationalization, and CRUD for Jobs with Categories.

The purpose of the application was to practice Hexagonal Architecture, Chicago Style Test-driven development, and CQRS.

It is based on Symfony 4, PHP 7.4. The response format of the API is based on JSend specification.

Prerequisites

  • PHP 7.4+
  • MySQL

How to deploy

  • Clone the repository.
git clone https://github.com/EresDev/Handwerker
  • Install it.
composer install
  • Create MySQL database if you have not already created.
php bin/console doctrine:database:create  --if-not-exists

It will give you errors if there is a problem in connecting to MySQL. Fix them accordingly. You can update the database details in .env file.

  • Create database schema
php bin/console doctrine:schema:create
  • Generate SSH keys
mkdir -p config/jwt
openssl genpkey -out config/jwt/private.pem -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096 -pass pass:879329hr8uhgf7834rhgiuw834hr
openssl pkey -in config/jwt/private.pem -out config/jwt/public.pem -passin pass:879329hr8uhgf7834rhgiuw834hr -pubout

Here 879329hr8uhgf7834rhgiuw834hr is the passphrase that you have to replace with one of your choice. If you are just performing a quick test, keep the value, it will help you get it working quickly but it must be taken care of before going to production.

  • Update the JWT_PASSPHRASE in .env or .env.local

  • Run the tests

composer test

Happy coding!