Skip to content

Home

Jump to bottom
Gregory McMullen edited this page Dec 9, 2021 · 2 revisions

Form Manager

Form Manager is the form management system for Xavier University. This system is developed solely for the use of Xavier University students, faculty and staff members.

Form Manager was initially developed as a ColdFusion application by Xavier University employees and was utilized until replaced by this system.

Development

Form Manager is built locally using Lando with the Laravel recipe. Laravel documentation.

Local Environment

As stated, the local environment uses a recipe for Laravel established by Lando coding standards. To start the local environment you will need to pull the repository to your local machine and run lando start

Composer will install the various php packages necessary to run the laravel project.

Make sure to create your .env file, copying the .env.example and running lando artisan key:generate to generate your APP_KEY. Other important information for the .env file:

APP_NAME = "Form Manager @ Xavier University"
APP_ENV = local
APP_DEBUG = true
APP_URL = http://form-manager.lndo.site

For the database connection see Connecting to your Database on the Lando Docs website.

As we are using breeze + inertia (with Vue.js) you will need to run lando npm install && lando npm run dev [ or watch ] to install dependencies and start Laravel Mix.

All Vue components can be found in resources/js/, CSS can be found in resources/css/app.css and the Models/Controllers can be found in their respective folders within app/Http.

Additional Services/Tooling

Beyond the main Laravel commands, you can also use the following tools and services:

  • PHPMyAdmin - Available after lando is fully operational via web browser
  • Node/NPM - Available using lando npm [command]

Contributing

Xavier Developers will have write access to the repository, without access to the main branch. All development should be done in feature branches and we will follow the following merge methodologies:

  • **Squash and Merge: ** Feature branch commits will be combined into a singular commit. This will be used for longer lists of individual commits that are all related. Commit messages should be edited to ensure readability and ensure future editors understand why something was written in.
  • Rebase and Merge: This will be used for one-off commits and/or hot fixes to keep the git history looking clean.

Branching Model

We will be using multiple branches to write code in this environment. Main must always remain clean and clear as it is the production branch. Development is what we run our local branches off of and must always be up-to-date with the latest code.

Once development is approved, we will merge it into the main branch for production release.

Clone this wiki locally