From 9c008c6a4f4c58978934cc35bb92e7ffe9097a15 Mon Sep 17 00:00:00 2001 From: Nabeel Shahzad Date: Tue, 9 Jan 2018 15:06:27 -0600 Subject: [PATCH] docs landing page --- docs/README.md | 84 -------------------------------------------------- docs/index.md | 42 +++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 84 deletions(-) delete mode 100755 docs/README.md create mode 100755 docs/index.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100755 index 440eadce..00000000 --- a/docs/README.md +++ /dev/null @@ -1,84 +0,0 @@ -# phpvms 7 - -[![Build Status](https://travis-ci.org/nabeelio/phpvms.svg)](https://travis-ci.org/nabeelio/phpvms) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d668bebb0a3c46bda381af16ce3d9450)](https://www.codacy.com/app/nabeelio/phpvms?utm_source=github.com&utm_medium=referral&utm_content=nabeelio/phpvms&utm_campaign=Badge_Grade) [![Total Downloads](https://poser.pugx.org/nabeel/phpvms/downloads)](https://packagist.org/packages/nabeel/phpvms) [![Latest Stable Version](https://poser.pugx.org/nabeel/phpvms/v/stable)](https://packagist.org/packages/nabeel/phpvms) [![Latest Unstable Version](https://poser.pugx.org/nabeel/phpvms/v/unstable)](https://packagist.org/packages/nabeel/phpvms) [![License](https://poser.pugx.org/nabeel/phpvms/license)](https://packagist.org/packages/nabeel/phpvms) - -The next phpvms version built on the laravel framework. work in progress. If you're looking for -the old, phpVMS classic, it's [available here](https://github.com/nabeelio/phpvms_v2). - -# installation - -A full distribution, with all of the composer dependencies, is available at this -[tarball link](http://phpvms.net/downloads/phpvms-7.0.0-master.tar.gz). It's currently -updated with every commit - -### Composer Access - -run the following commands. for right now, we're running on sqlite. for mysql, set -`DB_CONNECTION` to `mysql` in the `env.php` file. - -```bash -cp env.php.example env.php -composer install --no-interaction -php artisan database:create -php artisan migrate:refresh --seed -``` - -then point your webserver to the `/public` folder. - -By default, the Makefile calls the system-wide `composer`. If your host requires a -certain path or name for composer, add `COMPOSER=` to the front of the `make` command, e.g: - -```bash -COMPOSER=composer.phar make install -``` - -## development environment - -For development, copy the included `env.php.example` to `env.php` file. By default, it uses sqlite -instead of mysql. This makes it much easier to be able to clear the database and new fixtures. - -The easiest way to load locally is to install [Laravel Valet](https://laravel.com/docs/5.5/valet) -(if you're running a Mac). Once you install it, go to your phpvms directory, and run: - -```bash -cp env.php.example env.php -php artisan key:generate -make install # this will install everything -valet link phpvms -``` - -Now going to [http://phpvms.dev](http://phpvms.dev) should work. If you want to use mysql, -follow the valet directions on installing mysql (`brew install mysql`) and then update the -`env.php` file to point to the mysql. - -The default username and password are "admin@phpvms.net" and "admin". -To see the available users in the development environment, [see this file](https://github.com/nabeelio/phpvms/blob/master/database/seeds/dev.yml#L10) - -### creating/resetting the environment - -I use Makefiles to be able to quickly setup the environment. - -```bash -# to do an initial setup of the composer deps and install the DB -make install -``` - -Then to reset the database/clear cache, use: - -```bash -make reset -``` - -### database seeding - -There is a `database/seeds/dev.yml` which contains the initial seed data that can be used -for testing. For production use, there is a `prod.yml` file. The `make reset` handles seeding -the database with the data from the `dev.yml`. - -# updating - -extract files and run the migrations: - -```bash -php artisan migrate -``` diff --git a/docs/index.md b/docs/index.md new file mode 100755 index 00000000..a712eca2 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,42 @@ +# phpvms 7 + +[![Build Status](https://travis-ci.org/nabeelio/phpvms.svg)](https://travis-ci.org/nabeelio/phpvms) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d668bebb0a3c46bda381af16ce3d9450)](https://www.codacy.com/app/nabeelio/phpvms?utm_source=github.com&utm_medium=referral&utm_content=nabeelio/phpvms&utm_campaign=Badge_Grade) [![Total Downloads](https://poser.pugx.org/nabeel/phpvms/downloads)](https://packagist.org/packages/nabeel/phpvms) [![Latest Stable Version](https://poser.pugx.org/nabeel/phpvms/v/stable)](https://packagist.org/packages/nabeel/phpvms) [![Latest Unstable Version](https://poser.pugx.org/nabeel/phpvms/v/unstable)](https://packagist.org/packages/nabeel/phpvms) [![License](https://poser.pugx.org/nabeel/phpvms/license)](https://packagist.org/packages/nabeel/phpvms) + +The next phpvms version built on the laravel framework. This is a separate version from the old v2/v5 classic version. + +# installation + +## Requirements + +- PHP 7.0+, extensions: + - cURL + - JSON + - mbstring + - openssl + - pdo + - tokenizer +- Database: + - MySQL (or MySQL variant, including MariaDB, Percona) + - SQLite (for testing) + - Postgres is supported by Laravel but not enabled/tested for phpVMS, yet +- Apache or Nginx +- Redis (optional, for job queuing, various optimizations) + +## Download + +A full distribution, with all of the composer dependencies, is available at this +[tarball link](http://phpvms.net/downloads/phpvms-7.0.0-master.tar.gz). It's currently +updated with every commit + +## Upload the files + +If you're on shared hosting, just upload all of the files. If you have your own server, it's +recommended to create a vhost that points to the `/public` directory. ([see laravel's installation docs](https://laravel.com/docs/5.5/installation#web-server-configuration)) + +## Browse to the site + +Once you browse to the site, you will be given a link to the installer (`/install`) (Note: there +isn't a separate `install` folder). If the installation with the vhost and/or htaccess is working +correctly, you'll be able to see the installer. + +Follow the instructions to complete the install.