mirror of
https://github.com/opensupports/opensupports.git
synced 2025-07-31 01:35:15 +02:00
[DEV-371] Improve README (#1219)
This commit is contained in:
Maximiliano Redigonda
GitHub
parent
40016635a8
commit
20720ca4f9
80
DEVELOPMENT.md
Normal file
80
DEVELOPMENT.md
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
# Development
|
||||||
|
|
||||||
|
Here is a guide of how to set up the development environment in OpenSupports.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
* PHP 5.6+
|
||||||
|
* MySQL 4.1+
|
||||||
|
|
||||||
|
### Getting up and running FRONT-END (client folder)
|
||||||
|
1. Update: `sudo apt update`
|
||||||
|
2. Clone this repo: `git clone https://github.com/opensupports/opensupports.git`
|
||||||
|
3. Install `nvm`: https://github.com/nvm-sh/nvm
|
||||||
|
4. Use node version 11.15.0: `nvm install 11` followed by `nvm use 11`
|
||||||
|
5. Go to client: `cd opensupports/client`
|
||||||
|
6. Install dependencies: `npm install`
|
||||||
|
7. Rebuild node-sass: `npm rebuild node-sass`
|
||||||
|
8. Run: `npm start` (PHP server api it must be running at :8080)
|
||||||
|
10. Go to the main app: `http://localhost:3000/app`
|
||||||
|
11. Your browser will automatically be opened and directed to the browser-sync proxy address.
|
||||||
|
12. Use `npm start-fixtures` to 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: `client/webpack.config.js`.
|
||||||
|
|
||||||
|
##### Production Task
|
||||||
|
|
||||||
|
Just as there is a task for development, there is also a `npm build` 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 and the result store in `dist/` folder.
|
||||||
|
|
||||||
|
**Reminder:** Notice there is `index.html` and `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 `index.php`.
|
||||||
|
|
||||||
|
#### Frontend Unit Testing
|
||||||
|
1. Do the steps described before.
|
||||||
|
2. Install mocha: `npm install -g mocha@6.2.0`
|
||||||
|
3. Run `npm test` to run the tests.
|
||||||
|
|
||||||
|
### Getting up and running BACK-END (server folder)
|
||||||
|
1. Install [Docker CE](https://docs.docker.com/install/)
|
||||||
|
2. Go to the server folder: `cd opensupports/server`
|
||||||
|
3. Run `make build` to build the images
|
||||||
|
4. Run `make install` to install composer dependencies
|
||||||
|
|
||||||
|
- `make run` runs the backend and database
|
||||||
|
- `make stop` stop backend and database server
|
||||||
|
- `make log` show live server logs
|
||||||
|
- `make db` access to mysql database console
|
||||||
|
- `make sh` access to backend docker container bash
|
||||||
|
- `make test` run phpunit tests
|
||||||
|
- `make doc` to build the documentation (requires `apidoc`)
|
||||||
|
|
||||||
|
Server api runs on `http://localhost:8080/`
|
||||||
|
Also, there's a *phpmyadmin* instance running on `http://localhost:6060/`,
|
||||||
|
you can access with the username `root` and empty password
|
||||||
|
|
||||||
|
##### Building
|
||||||
|
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](https://github.com/opensupports/opensupports/wiki/Installation)
|
||||||
|
|
||||||
|
##### BACKEND API RUBY TESTING
|
||||||
|
|
||||||
|
1. Go to tests folder: `cd opensupports/tests`
|
||||||
|
2. Run `make build` to install ruby container and its required dependencies
|
||||||
|
|
||||||
|
- `make run` for running tests (database will be cleared)
|
||||||
|
- `make clear` for 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.
|
||||||
|
|
||||||
|
1. Install Java if you don't have it yet:
|
||||||
|
|
||||||
|
`sudo apt-get install default-jre`
|
||||||
|
`sudo apt-get install default-jdk`
|
||||||
|
|
||||||
|
2. [Download FakeSMTP](https://nilhcem.github.io/FakeSMTP/download.html)
|
||||||
|
|
||||||
|
3. Extract the file from the zip and run it:
|
||||||
|
|
||||||
|
`java -jar fakeSMTP-2.0.jar`
|
||||||
|
|
||||||
|
4. Set the port to 7070 and start the SMTP server.
|
||||||
|
|
||||||
|
5. Every time the application sends an email, it will be reflected there.
|
||||||
97
README.md
97
README.md
@ -1,86 +1,61 @@
|
|||||||
|
<div align="center">
|
||||||
|
|
||||||
[](https://travis-ci.org/opensupports/opensupports) v4.11.0
|
|
||||||
|
|
||||||
OpenSupports is an open source ticket system built primarily with PHP and ReactJS.
|
OpenSupports is a simple and beautiful open source ticket system. <br />
|
||||||
Please, visit our website for more information: [http://www.opensupports.com/](http://www.opensupports.com/)
|
<a href="https://www.opensupports.com/"><strong>Learn more »</strong></a>
|
||||||
|
<br />
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://www.opensupports.com/">Website</a> •
|
||||||
|
<a href="https://docs.opensupports.com/">Docs</a> •
|
||||||
|
<a href="https://opensupports.com/demo/">Demo</a> •
|
||||||
|
<a href="https://www.opensupports.com/pricing/">Official Subscription</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
## Requirements
|
</div>
|
||||||
* PHP 5.6+
|
|
||||||
* MySQL 4.1+
|
|
||||||
|
|
||||||
## Development
|
## 🌱 About the Project
|
||||||
Here is a guide of how to set up the development environment in OpenSupports.
|
|
||||||
|
|
||||||
### Getting up and running FRONT-END (client folder)
|
### What Customers See
|
||||||
1. Update: `sudo apt update`
|
|
||||||
2. Clone this repo: `git clone https://github.com/opensupports/opensupports.git`
|
|
||||||
3. Install `nvm`: https://github.com/nvm-sh/nvm
|
|
||||||
4. Use node version 11.15.0: `nvm install 11` followed by `nvm use 11`
|
|
||||||
5. Go to client: `cd opensupports/client`
|
|
||||||
6. Install dependencies: `npm install`
|
|
||||||
7. Rebuild node-sass: `npm rebuild node-sass`
|
|
||||||
8. Run: `npm start` (PHP server api it must be running at :8080)
|
|
||||||
10. Go to the main app: `http://localhost:3000/app`
|
|
||||||
11. Your browser will automatically be opened and directed to the browser-sync proxy address.
|
|
||||||
12. Use `npm start-fixtures` to 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: `client/webpack.config.js`.
|
|
||||||
|
|
||||||
##### Production Task
|
### What Staff Members See
|
||||||
|
|
||||||
Just as there is a task for development, there is also a `npm build` 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 and the result store in `dist/` folder.
|
|
||||||
|
|
||||||
**Reminder:** Notice there is `index.html` and `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 `index.php`.
|
## 🙌🏼 Ticket System for Absolutely Everyone
|
||||||
|
|
||||||
#### Frontend Unit Testing
|
OpenSupports is a simple and beautiful open source ticket system.
|
||||||
1. Do the steps described before.
|
|
||||||
2. Install mocha: `npm install -g mocha@6.2.0`
|
|
||||||
3. Run `npm test` to run the tests.
|
|
||||||
|
|
||||||
### Getting up and running BACK-END (server folder)
|
It is a web application that provides you with a better management of your users’ queries. They send you tickets through OpenSupports and you can handle them appropriately.
|
||||||
1. Install [Docker CE](https://docs.docker.com/install/)
|
|
||||||
2. Go to the server folder: `cd opensupports/server`
|
|
||||||
3. Run `make build` to build the images
|
|
||||||
4. Run `make install` to install composer dependencies
|
|
||||||
|
|
||||||
- `make run` runs the backend and database
|
Self-hosted, or [hosted by us](https://www.opensupports.com/pricing/), API-driven, and ready to be deployed on your own domain.
|
||||||
- `make stop` stop backend and database server
|
|
||||||
- `make log` show live server logs
|
|
||||||
- `make db` access to mysql database console
|
|
||||||
- `make sh` access to backend docker container bash
|
|
||||||
- `make test` run phpunit tests
|
|
||||||
- `make doc` to build the documentation (requires `apidoc`)
|
|
||||||
|
|
||||||
Server api runs on `http://localhost:8080/`
|
## 🧐 Stay Up-to-Date
|
||||||
Also, there's a *phpmyadmin* instance running on `http://localhost:6060/`,
|
|
||||||
you can access with the username `root` and empty password
|
|
||||||
|
|
||||||
##### Building
|
OpenSupports is growing and steadily incorporating new features. You might want to **add a star to the project** (or watch updates) to be notified about new releases.
|
||||||
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](https://github.com/opensupports/opensupports/wiki/Installation)
|
|
||||||
|
|
||||||
##### BACKEND API RUBY TESTING
|
## 💪🏼 Features
|
||||||
|
|
||||||
1. Go to tests folder: `cd opensupports/tests`
|
Check out our [most important features](https://opensupports.com/features) at our website.
|
||||||
2. Run `make build` to install ruby container and its required dependencies
|
|
||||||
|
|
||||||
- `make run` for running tests (database will be cleared)
|
Are we missing something? [Suggest an improvement](https://github.com/opensupports/opensupports/issues/new)!
|
||||||
- `make clear` for clearing database
|
|
||||||
|
|
||||||
##### BACKEND FAKE SMTP SERVER
|
## 🛠 Install
|
||||||
If you're doing development, you can use a FakeSMTP server to see the mails that are being sent.
|
|
||||||
|
|
||||||
1. Install Java if you don't have it yet:
|
OpenSupports can be hosted on your own servers, or [hosted by us](https://www.opensupports.com/pricing/).
|
||||||
|
|
||||||
`sudo apt-get install default-jre`
|
There are multiple benefits to having the system hosted by its creators, including official support into any problem you might encounter.
|
||||||
`sudo apt-get install default-jdk`
|
|
||||||
|
|
||||||
2. [Download FakeSMTP](https://nilhcem.github.io/FakeSMTP/download.html)
|
But in the case you prefer your development team to deal with the installation, maintenance (upgrades, backups, etc.), and integrations, we charge you nothing for it, OpenSupports is **free and open-source**!
|
||||||
|
|
||||||
3. Extract the file from the zip and run it:
|
Check out our [installation guide](https://docs.opensupports.com/guides/installation/).
|
||||||
|
|
||||||
`java -jar fakeSMTP-2.0.jar`
|
## 👨🏼💻 Development
|
||||||
|
|
||||||
4. Set the port to 7070 and start the SMTP server.
|
Are you a programmer? You can help us to fix bugs and build OpenSupports' features!
|
||||||
|
|
||||||
5. Every time the application sends an email, it will be reflected there.
|
Check out our [development guide](./DEVELOPMENT.md) to get your development environment up and running.
|
||||||
|
|
||||||
|
And even if you are not a programmer, you can help us by [reporting problems or suggesting improvements](https://github.com/opensupports/opensupports/issues/new), we love feedback and learn a lot from it!
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user