OpenSupports is an open source ticket system
OpenSupports is an open source ticket system built primarily with PHP and ReactJS. Please, visit our website for more information: http://www.opensupports.com/
Here is a guide of how to set up the development environment in OpenSupports.
sudo apt-get update
git clone https://github.com/opensupports/opensupports.git
sudo apt-get install curl
curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs
sudo apt-get install npm
npm rebuild node-sass
npm start(PHP server api it must be running at :8080)
http://localhost:3000/appor to the component demo
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:
Just as there is a task for development, there is also a
npm buildtask 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
Reminder: Notice there is
index.php. The first one searches the backend server where
config.jssays it, the second one uses
/apito find the server. If you want to run OpenSupports in a single server, then use
npm install -g [email protected]
npm testto run the tests.
make buildto build the images
make installto install composer dependencies
make runruns the backend and database
make stopstop backend and database server
make logshow live server logs
make dbaccess to mysql database console
make shaccess to backend docker container bash
make testrun phpunit tests
make docto build the documentation (requires
Server api runs on
http://localhost:8080/Also, there's a phpmyadmin instance running on
http://localhost:6060/, you can access with the username
rootand empty password
Once you've installed dependencies for frontend and backend, you can run
./build.shand 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
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-jre
sudo 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.