From 2d93a512361f1154f3d26e410bdd52459995145d Mon Sep 17 00:00:00 2001 From: Robbie Antenesse Date: Tue, 21 May 2019 19:42:38 -0600 Subject: [PATCH] Update README.md to be helpful --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e38918..f9035f3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,24 @@ This is the light-as-possible rewrite of Lexiconga. ## Installation -Clone and run `yarn` to install dependencies. +1. Clone and run `yarn` and `composer install` to install dependencies. +1. Import `src/structure.sql` into a database called 'lexiconga' on your MariaDB server to get the database structure. +1. Copy `src/php/api/config.php.changeme` to `src/php/api/config.php` and update the values within to enable connections to your lexiconga database. -`npm start` bundles and watches frontend changes. For backend stuff, set up a junction link to `dist` from the root of your php-processing server. \ No newline at end of file +### Requirements + +* [Yarn](https://yarnpkg.com/) 1.12.3+ +* [PHP](https://php.net/) 7.2.18+ +* [Composer](https://getcomposer.org/) 1.8.5+ +* [MariaDB](https://mariadb.org/) 10.1.37+ +* [Apache](https://httpd.apache.org/) 2.4+ + +## Development + +`npm start` bundles and watches frontend and backend changes. Set up a junction link to `dist` from the root of your php-processing web server. + +It's less useful, but `npm run serve-frontend-only` will bundle and serve _only_ the front end stuff from `localhost:1234`. The bundled files all still get bundled into `dist`. + +## Production + +`npm run bundle` bundles and minifies the frontend stuff and also copies the backend stuff to `dist`. Be sure to run `npm run clear` to delete the contents of `dist` and `.cache` before using `npm run bundle` to make sure you don't get old dev versions of the bundled code included in your upload. \ No newline at end of file