Table of contents
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?"
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.
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 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.
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) | ❌ |
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.
There are PHP packages and NPM packages in this project. The details of all these packages are down below.
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 | ❌ |
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. | ❌ |
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.
Installed in general:
Recommended installations for Windows
- Download Docker
- Follow the installation guide
Docker requires for Windows:
- 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.
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 |
This project is done by four students of NHL Stenden, within the minor The Next Web. School year 2020/2021, second semester.
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.
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.
The Laravel framework is open-sourced software licensed under the MIT license.