OpenSupports is a simple and beautiful open source ticket system
Go to file
Ivan Diaz 9b96309216 README.md edited online with Bitbucket 2015-12-26 22:43:39 +00:00
app [Ivan Diaz] - Create login user action 2015-09-23 23:49:24 -03:00
gulp [Ivan Diaz] - Add APIUtils and php api initial configuration 2015-10-30 23:20:35 -03:00
server [Ivan Diaz] - Add Mocks and Model tests 2015-11-27 19:58:05 -03:00
src [Ivan Diaz] - Add working login response 2015-11-01 18:43:35 -03:00
.gitignore [Ivan Diaz] - Add composer.lock to ignore 2015-11-18 22:01:13 -03:00
LICENSE Initial Commit 2015-08-15 20:47:51 -03:00
README.md README.md edited online with Bitbucket 2015-12-26 22:43:39 +00:00
database.sh [Ivan Diaz] - Update server folder structure 2015-10-28 20:47:40 -03:00
gulpfile.js Initial Commit 2015-08-15 20:47:51 -03:00
package.json [Ivan Diaz] - Add APIUtils and php api initial configuration 2015-10-30 23:20:35 -03:00
preprocessor.js [Ivan Diaz] - Add jest and demo page 2015-08-16 14:35:14 -03:00

README.md

OpenSupports v4.0

Getting up and running FRONT-END

  1. Clone this repo
  2. Install node sudo apt-get install node
  3. Install npm sudo apt-get install npm
  4. Install gulp sudo npm install -g gulp
  5. Go to repo cd os4-react
  6. Install npm dependences sudo npm install
  7. Run gulp dev

Getting up and running

  1. Create MySQL Database
  2. Clone this repo
  3. Run npm install from the root directory
  4. Create a mysql database
  5. Run gulp dev (may require installing Gulp globally npm install gulp -g)
  6. Your browser will automatically be opened and directed to the browser-sync proxy address
  7. To prepare assets for production, run the gulp prod task (Note: the production task does not fire up the express server, and won't provide you with browser-sync's live reloading. Simply use gulp dev during development. More information below)

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.

Create MySQL Database

  1. Install mysql-server

    Ubuntu

    sudo apt-get install mysql-server

    Cent OS

    sudo yum install mysql-server /etc/init.d/mysqld start

  2. Access the mysql shell

    mysql -u root -p

  3. Create a new database

    CREATE DATABASE os_dev;

  4. Assign privileges to user

    GRANT ALL PRIVILEGES ON os_dev.* To 'os_dev'@'localhost' IDENTIFIED BY 'os_dev';

  5. Run the MySQL server

    sudo /etc/init.d/mysql start

Production Task

Just as there is the gulp dev task for development, there is also a gulp prod task for putting your project into a production-ready state. This will run each of the tasks, while also adding the image minification task discussed above. There is also an empty gulp deploy task that is included when running the production task. This deploy task can be fleshed out to automatically push your production-ready site to your hosting setup.

Reminder: When running the production task, gulp will not fire up the express server and serve your index.html. This task is designed to be run before the deploy step that may copy the files from /build to a production web server.