WycliffeAssociates
/
en_btr_backend
9
0
Fork 1
Files Issues 1 Pull Requests Releases Wiki Activity See in Reader
23 Commits 1 Branch 0 Tags 5.6 MiB
PHP 64.1%
CSV 34.1%
HTML 1.3%
Shell 0.3%
JavaScript 0.2%
Go to file
Leonard Smith e208461642 Start rewriting the Readme 2021-02-12 10:00:45 -06:00
app Fix some LexicalEntry relationship references 2020-10-07 13:43:40 -05:00
bootstrap Initial commit 2020-10-02 10:58:41 -05:00
config Setup JSON:API for LexicalEntries 2020-10-06 22:28:24 -05:00
database Add migration for lexical_entry table 2020-10-06 20:26:13 -05:00
public Initial commit 2020-10-02 10:58:41 -05:00
resources Initial commit 2020-10-02 10:58:41 -05:00
routes Setup JSON:API for LexicalEntries 2020-10-06 22:28:24 -05:00
tests Add a test for Word and LexicalEntry relationships 2020-10-07 11:06:15 -05:00
.env.example Initial commit 2020-10-02 10:58:41 -05:00
.gitattributes Initial commit 2020-10-02 10:58:41 -05:00
.gitignore Ignore the .env_production file 2020-10-06 20:26:49 -05:00
.styleci.yml Initial commit 2020-10-02 10:58:41 -05:00
README.md Start rewriting the Readme 2021-02-12 10:00:45 -06:00
artisan Initial commit 2020-10-02 10:58:41 -05:00
composer.json Add support for json:api 2020-10-02 11:08:44 -05:00
composer.lock Add support for json:api 2020-10-02 11:08:44 -05:00
package.json Initial commit 2020-10-02 10:58:41 -05:00
phpunit.xml Initial commit 2020-10-02 10:58:41 -05:00
server.php Initial commit 2020-10-02 10:58:41 -05:00
webpack.mix.js Initial commit 2020-10-02 10:58:41 -05:00

README.md

Biblical Resources for Translators API

Laravel

The API is build in Laravel, a PHP framework. To get the backend up and running locally Laravel Homestead is the recommended approach. Laravel is currently on version 8, but our system is using the version 7.x series. Just make sure you grab the correct version to avoid any possible snags that could show up across major version.

Homestead uses Vagrant which is a virtual machine tool to make building and maintaining VMs easier. By using a VM to host the API server, we can avoid potential conflicts with the local development environment of our respective host machines. The files under development are stored in local folders on the host machine which are mapped to folders on the guest VM. The documentation on Vagrant and Homestead are quite helpful.

If Homestead is not an option, you may follow the installation directions in the Laravel documentation to install Laravel directly on your local machine and run php artisan serve. You will need to alter the Frontend's environment configuration to point to the correct server.