Deprecated

This repository has become too complex for a scaffolding. We believe that spliting this repository into two might be helpful for the two common and different use cases: cli-app or website.

Therefore, we have decided to deprecate this repository in favor of:

• cli-skeleton: A skeleton to build your cli-app using Phel.
• web-skeleton: A skeleton to build a website using Phel.

---

Phel Scaffolding

Phel is a functional programming language that compiles to PHP.

This repository provides you the basic setup to start coding phel.

Getting started

Requirements

Phel requires at least PHP 8.0 and Composer. You can either use it from your local machine OR using docker.

• This repository contains the basic Dockerfile to run phel.

Locally (no Docker)

1. Ensure you have PHP >=8.0 (Some help about how to install multiple PHP versions locally on linux and Mac)
2. Ensure you have composer
3. Clone this repo
4. Install the dependencies | composer install

Using Docker

1. Clone this repo
2. Build the image | docker-compose up -d --build
3. Go inside the console | docker exec -ti -u dev phel_scaffolding bash
4. Install the dependencies | composer install

Phel code

1. Write your phel code in src/
2. Execute your code with ./vendor/bin/phel run src/command/main.phel
3. Or with a PHP server with php -S localhost:8080 -t ./src/web

Tests

1. Write your phel tests in tests/
2. Execute your tests with ./vendor/bin/phel test

More about starting with phel

Find more information about how to start with phel in getting started.