# Caligrafy

Generated on 19 Jul 2023 from [the Caligrafy catalog page](https://marketplace.digitalocean.com/apps/caligrafy)

Caligrafy is a modern full stack Model-View-Controller (MVC) framework that was built from the ground up to bridge the power of server-side languages like PHP with the sophistication of client-side languages like Javascript.

Caligrafy provides easy and elegant ways for enthusiasts to build powerful web applications using cutting-edge Web capabilities.

This application creates a turn-key environment to run and deploy applications built with the Caligrafy Quill Framework

## Software Included

| Package | Version | License |
|---|---|---|
| PHP | 8.1.7 | |
| Composer | 2.4.1 | |
| Node | 18.7 | |
| NPM | 8.18 | |
| Docker | 20.10 | |
| Docker-Compose | 1.29.2 | |

## Creating an App using the Control Panel

Click the **Deploy to DigitalOcean** button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/droplets/new?image=caligrafybypostc-caligrafy)

## Creating an App using the API

In addition to creating a Droplet from the Caligrafy 1-Click App using the control panel, you can also use the [DigitalOcean API](https://docs.digitalocean.com/reference/api). As an example, to create a 4GB Caligrafy Droplet in the SFO2 region, you can use the following `curl` command. You need to either save your [API access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/index.html.md) to an environment variable or substitute it in the command below.

```shell
curl -X POST -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer '$TOKEN'' -d \
        '{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image":"caligrafybypostc-caligrafy"}' \
        "https://api.digitalocean.com/v2/droplets"
```

## Getting Started After Deploying Caligrafy

Upon activation of your droplet, you can immediately start using the Caligrafy Quill framework:

- Connect to your droplet command line using ssh root@your\_droplet\_public\_ipv4 or the web terminal provided by DigitalOcean
- Type “cd www/caligrafy-quill”
- To start the Caligrafy Quill server, type “.bin/caligrafer server start”. This starts the server and you can access the out-of-the-box Caligrafy application at http://your\_droplet\_ipv4:8080 and the out-of-the-box Caligrafy mysql database at http://your\_droplet\_ipv4:8077
- All the features are described in the Caligrafy documentation. Visit the documentation on [https://github.com/caligrafy/caligrafy-quill/wiki](https://github.com/caligrafy/caligrafy-quill/wiki)