Robbie Antenesse be67f965eb | ||
---|---|---|
dev | ||
src | ||
.gitignore | ||
.htmlnanorc | ||
.postcssrc | ||
README.md | ||
composer.json | ||
composer.lock | ||
manifest.webmanifest | ||
offline.html | ||
package.json | ||
template-index.html | ||
template-passwordreset.html | ||
template-view.html | ||
yarn.lock |
README.md
Lexiconga
This is the light-as-possible rewrite of Lexiconga.
Installation
- Some dev tools require build tools.
- On Windows, install them with
npm install --global windows-build-tools
. - Alternatively, you can just install the newest Python and Visual Studio (with Desktop C++ devkit).
- Clone and run
yarn
andcomposer install
to install dependencies. - Import
src/structure.sql
into a database called 'lexiconga' on your MariaDB server to get the database structure. - Copy
src/php/api/config.php.changeme
tosrc/php/api/config.php
and update the values within to enable connections to your lexiconga database.
Requirements
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
.
Parcel Bundler version < 2 doesn't use PostCSS 8+, so upgrading autoprefixer will not work. Keep autoprefixer at the highest version within the 9 major version until you're able to figure out how parcel-bundler 2+ works.
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.
Migration
There is a script called src/php/api/migrate.php.changeme
that can be used to help with the migration process from a version1
Lexiconga database into a master
database. Note: Migration is intended only for migrating from an old server to a freshly-installed/empty new database. To use this, copy src/php/api/migrate.php.changeme
to migrate.php
somewhere in the version1
project (probably in /php
) and copy the same to /api/migrate.php
in your master
project, making sure that all the variables for referencing the databases are correct.
Visit migrate.php
on your version1
server with ?outgoing=true
set in order to begin the transfer. The other server's migrate.php
will receive an "incoming" request multiple times, and your screen will display messages as it works.
DELETE THESE migrate.php
FILES IMMEDIATELY AFTER MIGRATION IS COMPLETE!.
Emails
Be sure you set up email senders/receivers for at least these 3 email addresses:
- help (can be forwarder)
- donotreply (must be sender)