OpenSupports is an open source ticket system built primarly 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
- update
sudo apt-get update
- Clone this repo
- 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 repo
cd os4-react/client
- Install dependences
npm install
- Rebuild node-sass
npm rebuild node-sass
- Run
gulp dev
- Go to the main app:
http://localhost:3000/app
or the component demohttp://localhost:3000/demo
- Your browser will automatically be opened and directed to the browser-sync proxy address
- Use
gulp dev --api
to disable fixtures and use the real php server api (it must be running at :8080).
Now that 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.
Just as there is the 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.html
and index.php
. The firstone searches the backend server where config.js
say 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 "sudo npm install -g mocha"
- Run
npm test
to run the tests
- Clone this repo
- Install PHP 5.6
- Create MySQL Database
- Install composer
- Go to
cd os4-react/api
- Run
composer install
- Run the server with
php -S localhost:8080
-
Install mysql-server
Ubuntu
sudo apt-get install mysql-server
Cent OS
sudo yum install mysql-server
/etc/init.d/mysqld start
-
Access the mysql shell
mysql -u root
-
Create a new database
CREATE DATABASE development;
-
Run the MySQL server
sudo /etc/init.d/mysql start
- Install ruby
sudo apt-get install ruby-full
- Install mysql dev dependencies
sudo apt-get install libmysqlclient-dev libmysqlclient16 ruby-dev
- Install bundle
sudo gem install bundler
- Go to test folder
cd os4-react/tests
- Install project dependencies
sudo gem install bundler
Test can run by using executingrun-tests.sh
file.
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 jet
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.