661502051c | ||
---|---|---|
client | ||
server | ||
.gitignore | ||
LICENSE | ||
README.md |
README.md
OpenSupports v4.0
Getting up and running FRONT-END (client folder)
- 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
- 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.
Getting up and running BACK-END (server folder)
- Clone this repo
- Install PHP5
- Create MySQL Database
- Install composer
- Go to
cd os4-react/api
- Run
composer install
- Run the server with
php -S localhost:8080
Create MySQL Database
-
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 -p
-
Create a new database
CREATE DATABASE os_dev;
-
Assign privileges to user
GRANT ALL PRIVILEGES ON os_dev.* To 'os_dev'@'localhost' IDENTIFIED BY 'os_dev';
-
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.