Updated install information

Author: sdkfuyr

README.md

@@ -1,42 +1,61 @@
 # FlexForm - Lightweight Form Server
 
-## Introduction
-
 Welcome to FlexForm, a fully open-source, headless form server designed with simplicity, efficiency, and privacy in mind. Built to be easily installed on any budget-friendly hosting solution or free cloud tiers, FlexForm is the perfect choice for developers and businesses looking for a reliable and GDPR-compliant form management solution.
 
 <img src="./public/images/screen.png" width="100%">
 
-## Features
+# Features
 
 - **Headless Architecture**: FlexForm is built as a headless server, offering flexibility and ease of integration with various frontend systems.
 - **Robust Admin Panel**: Manage your forms with ease using our user-friendly admin panel, designed for efficient and intuitive form management.
 - **Cost-Effective**: Designed to run smoothly on inexpensive hosting or free cloud services, reducing your operational costs.
 - **GDPR Compliant**: We prioritize your data privacy. FlexForm ensures that all your data remains yours, complying fully with GDPR regulations.
 - **Open Source**: Dive into the code, customize, and contribute! Our community-driven approach means FlexForm is continually evolving.
 
-## License
+# Requirements
+### PHP Version
+- PHP 8.2 or higher.
+
+### PHP Extensions
+- GD
+- ZIP
+- XML
+
+### Supported Databases
+- SQLite
+- MySQL
+- PostgreSQL
+- MariaDB
+- AuroraDB
+
+# License
 
 FlexForm is released under MIT, ensuring it remains free and open for use and modification.
 
-## Getting Started
+# Getting Started
+
+ - [Deploying on cloud hosting](#deploying-on-cloud-hosting)
+ - [Deploying on shared hosting](#deploying-on-shared-hosting)
+ - [Running locally with docker](#running-locally-with-docker)
+ - [Running locally without docker](#running-locally-with-php-server)
+ - [Deploy instructions](#deploy-instructions)
+
 
-### How to run locally with docker
-Checkout the repository jump to the folder and run the following commands:
+## Running locally with docker
+Use the latest [image from docker hub](https://hub.docker.com/r/flexform/flexform-server) to run it locally:
 ```bash
-docker-compose up
+docker run --name flexform -d -p 9000:9000 flexform/flexform-server:0.1
 ```
 Run DB migrations from container
 ```bash
+docker exec -it flexform bash
 php bin/console doctrine:migrations:migrate
 ```
 
-### How to run locally without docker
+## Running locally with PHP server
 Make sure you have PHP 8.2 and composer installed.
 Checkout the repository jump to the folder.
 Copy environment file and adjust it to your needs:
-```bash
-cp .env.dev .env
-```
 Install dependencies:
 ```bash
 composer install
@@ -50,16 +69,14 @@ Run the server:
 php -S localhost:8000 -t public
 ```
 
-### How to install on shared hosting
-Build the project on your local machine or download prebuild release from [here](https://flexform.nyc3.cdn.digitaloceanspaces.com/flexform-server-latest.zip).
+## Deploying on shared hosting
+Build the project on your local machine or [download prebuild release](https://flexform.nyc3.cdn.digitaloceanspaces.com/flexform-server-latest.zip).
 Upload the files to your shared hosting.
+Make sure you make "public" folder as your main folder.
 
-Make sure you:
-- Set the environment variable `APP_ENV` to `prod` in your `.env` file. See [.env.prod](.env.prod) for an example.
-
-### Deploy on cloud hosting
+## Deploying on cloud hosting
 You can deploy FlexForm on any cloud hosting provider that supports PHP 8.2 or higher.
-Also you can use our Dockerfile to deploy FlexForm on any cloud hosting provider that supports docker.
+Also you can use [FlexForm Docker Image](https://hub.docker.com/r/flexform/flexform-server) to deploy FlexForm on any cloud hosting provider that supports docker.
 
 Make sure you:
 - Set the environment variable `APP_ENV` to `prod`
@@ -68,10 +85,12 @@ Make sure you:
 
 You can see an example of environment variables in the [.env.prod](.env.prod) file.
 
-### Deploy instructions
+**Please make sure you made /app/var as persistent storage if you use SQLite. If you want to use other database please change DATABASE_URL env variable.**
+
+## Deploy instructions
  - [Installing FlexForm on DigitalOcean Apps](https://medium.com/@ashelestov/installing-flexform-on-digitalocean-apps-b3e5b1ba868a)
 
-## Frontend components
+# Frontend components
 FlexForm is a headless form server. This means that you can use any frontend framework to build your forms.
 We provide a set of frontend components that you can use to build your forms.