From e20846164285b6181e538132f0d35e067eecb587 Mon Sep 17 00:00:00 2001 From: Leonard Smith Date: Fri, 12 Feb 2021 10:00:45 -0600 Subject: [PATCH] Start rewriting the Readme --- README.md | 70 +++++++++++-------------------------------------------- 1 file changed, 13 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index f3decb1..b14b691 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,17 @@ -

+# Biblical Resources for Translators API -

-Build Status -Total Downloads -Latest Stable Version -License -

+## Laravel +The API is build in [Laravel](https://laravel.com/docs/7.x), a PHP framework. To get the backend up and running locally +[Laravel Homestead](https://laravel.com/docs/7.x/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. -## About Laravel +Homestead uses [Vagrant](https://www.vagrantup.com) 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. -Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: +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. -- [Simple, fast routing engine](https://laravel.com/docs/routing). -- [Powerful dependency injection container](https://laravel.com/docs/container). -- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. -- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). -- Database agnostic [schema migrations](https://laravel.com/docs/migrations). -- [Robust background job processing](https://laravel.com/docs/queues). -- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). - -Laravel is accessible, powerful, and provides tools required for large, robust applications. - -## Learning Laravel - -Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. - -If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. - -## Laravel Sponsors - -We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell). - -### Premium Partners - -- **[Vehikl](https://vehikl.com/)** -- **[Tighten Co.](https://tighten.co)** -- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** -- **[64 Robots](https://64robots.com)** -- **[Cubet Techno Labs](https://cubettech.com)** -- **[Cyber-Duck](https://cyber-duck.co.uk)** -- **[Many](https://www.many.co.uk)** -- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** -- **[DevSquad](https://devsquad.com)** -- **[OP.GG](https://op.gg)** - -## Contributing - -Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). - -## Code of Conduct - -In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). - -## Security Vulnerabilities - -If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed. - -## License - -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).