E Physio
Table of contents
The e-physio project
About e-physio and the assignment
Two physiotherapists have started their own website to offer online physiotherapy for people that need therapy and mainly work at home. The current website is built in Wordpress and suits the needs for them right now, but the website isn't ready for their future plans. That is why they came to the minor The Next Web with a assignment: build a platform for health seekers who would like to have online therapy. This assignment raised questions as "how can we attract people to the services of e-physio?" and "what is the best way to guide people through the process of making an appointment?"
The study and this project
This project is being done by four students of the study Communication & Multimedia Design (CMD) within the minor The Next Web from NHL Stenden, university of applied sciences.
CMD is an study that uses Design Based Education. It also offers the method Design Thinking to structure the projects. Within the minor The Next Web, we use Scrum for the development of the product. When combined, the Scrum sprints feature the five phases of Design Thinking.
Objectives
The main objective from the two clients is as follows: develop a proof-of-concept in the form such as a roadmap, app, or website that support eachother.
This repository
This repository contains all the code that was developed during the project. The used workflow for this Git repository is Git Flow. All branches can be found here.
Features
Per part of the application is noted what feature is included in this repository and what feature is not. The emojis tell you what feature is included and what each feature is.
There are three parts of the application:
- General pages
- The client portal
- The physician portal
Legend
šļø Lay-out:
- Framework for each page
- Metadata of each page
- Navigation bar
- Footer
š Page:
- Contents of the page
- Markup and styling
- Illustrations and animations
āļø Controller:
- Sends and receives data fom database
- Takes care of the pages
| 1: General pages | Included? |
|---|---|
| šļø Lay-out general | ā |
| š Home page | ā |
| š Contact page | ā |
| š About page | ā |
| š FAQ page | ā |
| š Blog page | ā |
| āļø Blog posts controller | ā |
| š Log-in page | ā |
| āļø Log-in controller | ā |
| 2: Client portal | Included? |
|---|---|
| šļø Lay-out onboarding (clients) | ā |
| š Symptoms page | ā |
| š Planner page | ā |
| š Choices page | ā |
| š Confirmation page | ā |
| āļø Onboarding controller | ā |
| šļø Lay-out portal (clients) | ā |
| š Calendar page (clients) | ā |
| āļø Calendar controller (clients) | ā |
| š Account page (clients) | ā |
| āļø Account controller (clients) | ā |
| 3: Physician portal | Included? |
|---|---|
| šļø Lay-out onboarding (physicians) | ā |
| š Registration page | ā |
| āļø Registration controller | ā |
| š Physician profile page | ā |
| āļø Physician profile controller | ā |
| šļø Lay-out portal (physicians) | ā |
| š Profile page | ā |
| āļø Profile controller | ā |
| š Work week page | ā |
| āļø Work week controller | ā |
| š Calendar page (physicians) | ā |
| āļø Calendar controller (physicians) | ā |
| š Account page (clients) | ā |
| āļø Account controller (clients) | ā |
Technical details
Cloning and forking
When this project is completed, is is possible to clone or fork this project to get a copy of the project. You can find more about cloning and forking on the GitHub Docs.
Packages and depenencies
There are PHP packages and NPM packages in this project. The details of all these packages are down below.
PHP packages
All PHP packages and their versions can be found in composer.json. These packages are managed by Composer.
| Package | Description | Used? |
|---|---|---|
| PHP | PHP is a popular general-purpose scripting language that is especially suited to web development. | āļø |
| Laravel Framework | A web application framework. | āļø |
| Laravel Sail | Docker files for running a basic Laravel application. | āļø |
| Laravel Tinker | Powerful REPL for the Laravel framework. | āļø |
| Laravel Cors | Adds CORS (Cross-Origin Resource Sharing) headers support in the Laravel application. | āļø |
| Laravel Breeze | Minimal Laravel authentication scaffolding with Blade and Tailwind. | āļø |
| Faker | Faker is a PHP library that generates fake data. | āļø |
| Carbon | An international PHP extension for DateTime. | āļø |
| fideloper/proxy | ā | |
| guzzlehttp/guzzle | ā | |
| facade/ignition | ā | |
| mockery/mockery | ā | |
| nunomaduro/collision | ā | |
| phpunit/phpunit | ā |
NPM packages
All NPM packages and their versions can be found in package.json. These packages are managed by Node Package Manager.
| Package | Description | Used? |
|---|---|---|
| Tailwind CSS | A utility-first CSS framework for rapid UI development. | āļø |
| Tailwind CSS / forms | A plugin that provides a basic reset for form styles. | āļø |
| Tailwind CSS / typography | Adds typographic defaults to any vanilla HTML. | āļø |
| PostCSS | A tool for transforming styles with JavaScript plugins. | āļø |
| Autoprefixer | A plugin to parse CSS. | āļø |
| Laravel Mix | Compiling CSS and JavaScript assets. | āļø |
| Alpine.js | ā | |
| Axios | ā | |
| Lodash | ā | |
| Stimulus | A JavaScript framework. | ā |
How to install this project
This project uses Docker and Laravel Sail to run. Laravel itself and it's (references to) packages such as Tailwind are already included within the project.
Prerequisites
Installed in general:
Recommended installations for Windows
Installing Docker
- Download Docker
- Follow the installation guide
Docker requires for Windows:
Installing Laravel Sail
- Follow the installation guide on Laraval Sail: Installing Sail Into Existing Applications
- Optionally, you can configure a Bash alias
You can find more on installing Laravel here.
How to use this project
There are a few commands to get going with this project. Normally the php command is used, but this gets replaced by the sail command. Compling the assets such as the CSS from Tailwind happens with Laravel Mix.
| Command | Description |
|---|---|
sail up |
Start the application's containers |
sail artisan tinker |
Start the command line for the Laravel application |
npm run dev |
Run all Mix tasks |
npm run watch |
Run all Mix tasks on file change |
npm run prod |
Run all Mix tasks and minify output |
Credits and copyright
This project is done by four students of NHL Stenden, within the minor The Next Web. School year 2020/2021, second semester.
Contact details
For any questions about the project you can send the owner of this repository an email. The full contact details of all team members can be found in the documentation of the project.
Terms and conditions
The terms and conditions as mentioned in "Algemene voorwaarden kennisdiensten" ("General terms and conditions knowledge services") apply to this project. In short, NHL Stenden keeps the intellectual property rights about this project. More on this and other clauses can be found in said document.
Laravel license
The Laravel framework is open-sourced software licensed under the MIT license.
