OpenSupports is an open source ticket system built primarily with PHP and ReactJS. Please, visit our website for more information: http://www.opensupports.com/
- PHP 5.6+
- MySQL 4.1+
Here is a guide of how to set up the development environment in OpenSupports.
Getting up and running FRONT-END (client folder)
sudo apt-get update
- Clone this repo:
git clone https://github.com/opensupports/opensupports.git
- Install node 4.x version:
sudo apt-get install curl
curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs
- Install npm:
sudo apt-get install npm
- Install gulp:
sudo npm install -g gulp
- Go to client:
- Install dependencies:
- Rebuild node-sass:
npm rebuild node-sass
- Go to the main app:
http://localhost:3000/appor to the component demo
- Your browser will automatically be opened and directed to the browser-sync proxy address.
gulp dev --apito disable fixtures and use the real PHP server api (it must be running at :8080).
gulp dev is running, the server is up as well and serving files from the
/build directory. Any changes in the
/src directory will be automatically processed by Gulp and the changes will be injected to any open browsers pointed at the proxy address.
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
gulp dev task for development, there is also a
gulp prod 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.
Reminder: Notice there is
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
Frontend Unit Testing
- Do the steps described before.
- Install mocha:
sudo npm install -g mocha
npm testto run the tests.
Getting up and running BACK-END (server folder)
- Install Docker CE
- Go to the server folder:
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
Server api runs on
Also, there's a phpmyadmin instance running on
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
BACKEND API RUBY TESTING
- Go to tests folder:
make installto install ruby and its the required dependencies
make runfor running tests (database will be cleared)
make clearfor clearing database
BACKEND FAKE SMTP SERVER
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.