gabe565/mnemonic-ninja repository overview

⁠

⁠Mnemonic Ninja

Website to convert between a number and its corresponding word to aid in memorization. Unlike some of the other sites that I had tried out, this one processes conversions by looking at the phonetic pronounciation of a word and not just converting by specific letter.
View the live site at https://mnemonic.ninja/⁠

⁠Requirements

• PHP >= 7.0.0
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension
• MySQL, PostgreSQL, SQLite, or SQL Server

⁠Installation

This project is built with Lumen⁠ as the API framework and Vue.js⁠ as a JavaScript controller.

1. To obtain the code, simply run

   git clone --recursive https://github.com/gabe565/mnemonic-ninja
   cd mnemonic-ninja
   

   Copy

2. Then, copy .env.example to .env and edit the file to set environment variables.
   An application key must be generated by running

   php artisan key:generate
   

   Copy

3. To setup the database tables, run

   php artisan migrate
   

   Copy

4. Finally, to populate the database with phonetic data and conversions, run

   php artisan db:seed
   

   Copy

⁠Running with Docker

There is a Docker container based on the php:7.2-fpm-alpine image.
Environment variables match the .env.example⁠ file.

docker pull gabe565/mnemonic-ninja

Documentation on running and configuring will be added here soon.