6becc6de63
Updated `docker-compose.local.yml` to `docker-compose.dev.yml` to reflect the correct docker files
62 lines
2.3 KiB
Markdown
Executable File
62 lines
2.3 KiB
Markdown
Executable File
# phpVMS <sup>7</sup>
|
|
|
|
[](https://github.com/nabeelio/phpvms/actions) [](https://www.codacy.com/app/nabeelio/phpvms?utm_source=github.com&utm_medium=referral&utm_content=nabeelio/phpvms&utm_campaign=Badge_Grade) [](https://packagist.org/packages/nabeel/phpvms)  [](https://packagist.org/packages/nabeel/phpvms)
|
|
|
|
The next phpvms version built on the laravel framework. work in progress. The latest documentation, with installation instructions is available [on the phpVMS documentation](https://docs.phpvms.net/) page.
|
|
|
|
## Installation
|
|
|
|
A full distribution, with all of the composer dependencies, is available at this
|
|
[GitHub Releases](https://github.com/nabeelio/phpvms/releases) link.
|
|
|
|
### Requirements
|
|
|
|
- PHP 8.0+, extensions:
|
|
- cURL
|
|
- JSON
|
|
- mbstring
|
|
- openssl
|
|
- pdo
|
|
- tokenizer
|
|
- Database:
|
|
- MySQL 5.5+ (or MySQL variant, including MariaDB and Percona)
|
|
|
|
[View more details on requirements](https://docs.phpvms.net/requirements)
|
|
|
|
### Installer
|
|
|
|
1. Upload to your server
|
|
1. Visit the site, and follow the link to the installer
|
|
|
|
[View installation details](https://docs.phpvms.net/installation/installation)
|
|
|
|
## Development Environment with Docker
|
|
|
|
A full development environment can be brought up using Docker, without having to install composer/npm locally
|
|
|
|
```bash
|
|
make docker-test
|
|
|
|
# **OR** with docker-compose directly
|
|
|
|
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
|
|
```
|
|
|
|
Then go to `http://localhost`. If you're using dnsmasq, the `app` container is listening on `phpvms.test`, or you can add to your `/etc/hosts` file:
|
|
|
|
```
|
|
127.0.0.1 phpvms.test
|
|
```
|
|
|
|
The `docker-compose.local.yml` overrides the `app` section in `docker-compose.yml`. The standard `docker-compose.yml` can be used if you want to deploy from the image, or as a template for your own Dockerized deployments.
|
|
|
|
### Building JS/CSS assets
|
|
|
|
Yarn is required, run:
|
|
|
|
```bash
|
|
make build-assets
|
|
```
|
|
|
|
This will build all of the assets according to the webpack file.
|