Welcome to the Eventus Server

the Back End API for the Eventus cluster of applications

Extensive Documentation can be found in the Eventus Server Wiki

This project uses Laravel Framework
We're using Laravel (PHP) to build out the API. All structure is discussed and defined by the framework developers. All content in this repository is required for the functionality (or future functionality) of the server application.

Here is the general structure for the parts of the architecture that we have implemented:

- app
  - Exceptions
    - EventusException: A generic parent Exception for our server application.
    - Handler(modified): Added a hook in render() that sends a JSON response instead of a rendered HTML page.
  - Http
    - Controllers
      - EventController: Handles interaction between the Event objects, the persistence layer, and children.
      - ServiceController: Handles interaction between the Service objects, the persistence layer, and children.
      - ServiceTagController: Handles interaction between the ServiceTag objects and the persistence layer.
    - Middleware
      - CorsHeaders: Adds the headers necessary to allow Cross-Origin Resource Sharing.
      - EventusJsonResponseFormat: Modifies the outgoing response in-transit to meet our Eventus JSON spec.
  - Event: Class definition for an Eventus Event object.
  - Service: Class definition for an Eventus Service object.
  - ServiceTag: Class definition for an Eventus ServiceTag object.
- database
  - factories
    - ModelFactory(modified): Model Factories allow us to create mock data for our resources. Mostly for testing.
  - migrations
    - <several migrations>: All the migrations files are defined by us, they allow us to add/remove changes to the database.
- routes
  - api: under the subdirectory `<server-address>/api/` are the routes listed here.
- tests
  - EventAPITest: Integration tests over the individual API routes (more specifically, their associated Controller methods.)
  - ServiceAPITest: Same as above.
  - ServiceTagAPITest: Same as above.
  - ExampleTest(modified): Runs creations using faker (the Model Factory library) to ensure they're working.

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb combination of simplicity, elegance, and innovation give you tools you need to build any application with which you are tasked.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of any modern web application framework. The Laravel documentation is thorough, complete, and makes it a breeze to get started learning the framework.

If you're not in the mood to read, Laracasts contains over 900 video tutorials on a range of topics including Laravel, modern PHP, unit testing, JavaScript, and more. Boost the skill level of yourself and your entire team by digging into our comprehensive video library.

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at taylor@laravel.com. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.