OrangeSolutions is a Patient Management System that allows medical professionals to service patients remotely.
- Yinan Zhou
- Joy White
- Benjamin Allen
- William Xiao
- Shi Wang
- PHP 5.6+
- Composer (https://getcomposer.org/)
- ThinkPHP 5.1 (https://github.com/top-think/think/tree/5.1)
- MySQL or MariaDB
- Google reCAPTCHA (https://www.google.com/recaptcha/)
- Controllers are placed under
application/portal/Controller. They handle service logic. - Data Models are placed under
application/common/model. They are entities associated with database table. - Views are placed under
application/portal/view. They are the web interface for client browsers. - Config files are placed under
config. - Routing definitions are placed under
route. They decided which controller should a specific url being mapped to. publicfolder holds files that are publically directly accessible.runtimefolder holds cache files during runtime
We provides two options for you to try out our system.
If you are a student on Syracuse University CIS 454 and you are assigned our project for your software testing assignment, instead of taking enumerous amount of time deploy our system, you can try out OrangeSolutions by an already on-the-cloud deployment maintained by our team at https://orangesolutions.tk.
We go to great length to make sure the on-the-cloud version will keep available until May 12, 2018.
Also, we would like to let you know that your password is always stored with one-way hashing using bcrypt algorthim, so we are not able to see your password. Implementation can be found inside application/portal/controller/Auth.php.
OrangeSolutions utlizes Google reCAPTCHA to prevent brute force password cracking or abuse of system functions by automated software. Thus, reCAPTCHA API Keys is required.
Please obtain a pair of Google reCAPTCHA V2 API keys at https://www.google.com/recaptcha/. You will need this pair of keys later.
As the system stores and processes educational information, the system is designed to serve all the connections over HTTPS. Some critical function inside the system may not work correctly without HTTPS. For example, the system by default set all cookies to be transmitted only on HTTPS connection.
We suggest the following tutorial https://www.digitalocean.com/community/tutorials/openssl-essentials-working-with-ssl-certificates-private-keys-and-csrs
NOTE: Self-signed certificate are not trusted by client browsers by default. Browser may raise warning or even block the connection if the certificiate is not trusted.
You can obtain or purchase certificate for your domain from any trsuted Certificate Authority (CA). We suggest obtaining the certificate from Let's Encrypt (https://letsencrypt.org/getting-started/), which is fast and free.
If you do not already have the source code in the deployment environment, you can quickly obtain a copy by running git clone [email protected]:yinanzhou/OrangeSolutions.git REPLACE_HERE_WITH_PATH_YOU_WANT. Please change your webserver setting accordingly. The document root should be the public folder inside the application root directory.
Our recommended shortcut for deployment is using Linux + Nginx + MySQL + PHP, we suggest using the following tutorial https://www.digitalocean.com/community/tutorials/how-to-install-linux-nginx-mysql-php-lemp-stack-in-ubuntu-16-04.
Please also install the php-curl library, as curl is used when connecting with Google reCAPTCHA service. On Debian/Ubuntu, you can run apt-get install php-curl.
You do not have to use Nginx. Please note that some of the configuration are passed via environment variable, please refer to Sample Nginx configuration File for those environment variable you need to set up.
Please run the install/database.sql to establish the database tables.
Please also create a database user named "orangesolutions" and grant access to "orangesolutions" database.
OrangeSolutions uses Composer as its dependency manager. All dependencies are recorded into composer.json file located in the root directory.
To install Composer, follow the documentation on https://getcomposer.org/.
After Composer is intalled, run composer install on the command line inside the application root directory.
Under the application root directory there is a folder named runtime, please grant write access for www-data user, which is used by php-fpm. Otherwise the system won't be able to function correctly.
You can set this by running chown www-data:www-data runtime under the application root directory.
Now your own copy of OrangeSolutions should be up and running. You can register an account and access the system. You will see an option to upgrade yourself to an administrator if there is no administrator in the system (which is true for new installation).
Copyright 2018 Yinan Zhou, Joy White, Benjamin Allen, William Xiao, and Shi Wang
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Most of the codes depend on ThinkPHP 5.1 framework, which is also licensed under the Apache License, Version 2.0. See Dependencies section for details.