This system is a fork of OpenSupports, an open source ticket system built primarily with PHP and ReactJS. Please, visit OpenSupports website for more information: http://www.opensupports.com/.
This fork has extra features to create restrictions and make plans, let's say to sell the system as SaaS, perhaps in a rudimentary way.
For example, suppose a company needs a support system:
This company has a number of departments and helpdesk employees that will support users of client companies.
As a provider of this support system, you can deploy on a web server a customized copy with a maximum number of departments, a maximum number of helpdesk workers, a maximum number of client companies, as well as a maximum number of users in client companies.
A key was also added to prevent access to the system installer.
- PHP 5.6+
- MySQL 4.1+
Here is a guide of how to set up the development environment in OpenSupports.
- Update:
sudo apt-get update - Clone this repo:
git clone https://github.com/opensupports/opensupports.git - Install node 4.x version:
sudo apt-get install curlcurl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -sudo apt-get install -y nodejs
- Install npm:
sudo apt-get install npm - Go to client:
cd opensupports/client - Install dependencies:
npm install - Rebuild node-sass:
npm rebuild node-sass - Run:
npm start(PHP server api it must be running at :8080) - Go to the main app:
http://localhost:3000/appor to the component demohttp://localhost:3000/demo - Your browser will automatically be opened and directed to the browser-sync proxy address.
- Use
npm start-fixturesto enable fixtures and not require php server to be running.
OpenSupport uses by default the port 3000, but this port could already be used. If this is the case, you can modify this in the file: client/webpack.config.js.
Just as there is a task for development, there is also a npm build task for putting the project into a production-ready state. This will run each of the tasks, while also adding the image minification task discussed above and the result store in dist/ folder.
Reminder: Notice there is index.html and index.php. The first one searches the backend server where config.js says it, the second one uses /api to find the server. If you want to run OpenSupports in a single server, then use index.php.
- Do the steps described before.
- Install mocha:
npm install -g [email protected] - Run
npm testto run the tests.
- Install Docker CE
- Go to the server folder:
cd opensupports/server - Run
make buildto build the images - Run
make installto install composer dependencies
make runruns the backend and databasemake stopstop backend and database servermake logshow live server logsmake dbaccess to mysql database consolemake shaccess to backend docker container bashmake testrun phpunit testsmake docto build the documentation (requiresapidoc)
Server api runs on http://localhost:8080/
Also, there's a phpmyadmin instance running on http://localhost:6060/,
you can access with the username root and empty password
Once you've installed dependencies for frontend and backend, you can run ./build.sh and it will generate a zip file inside dist/ ready for distribution. You can use this file to install OpenSupports on a serving following the installation instructions
- Go to tests folder:
cd opensupports/tests - Run
make buildto install ruby container and its required dependencies
make runfor running tests (database will be cleared)make clearfor clearing database
If you're doing development, you can use a FakeSMTP server to see the mails that are being sent.
-
Install Java if you don't have it yet:
sudo apt-get install default-jresudo apt-get install default-jdk -
Extract the file from the zip and run it:
java -jar fakeSMTP-2.0.jar -
Set the port to 7070 and start the SMTP server.
-
Every time the application sends an email, it will be reflected there.