Skip to content

Commit 21b013d

Browse files
committed
Readme section was moved to contributing guide
1 parent 641392b commit 21b013d

File tree

2 files changed

+2
-72
lines changed

2 files changed

+2
-72
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ Configure nginx so that it is a fastcgi proxy to php-fpm. You will then run
9696
`composer install` to get additional vendor files required for this project.
9797

9898
Nginx should be pointed at the [src/main.php](./src/main.php) file for all
99-
requests.
99+
requests. A sample config exists at
100+
[etc/nginx-vhost-sample.conf](./etc/nginx-vhost.sample.conf).
100101

101102
MariaDB should be configured with the `TRADITIONAL,NO_AUTO_VALUE_ON_ZERO` modes.
102103
A sample configuration can be found at

README.md

Lines changed: 0 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -8,77 +8,6 @@ Battle.net™ and in-game protocols.
88
**BNETDocs: Phoenix** is the successor to
99
[BNETDocs: Redux](https://github.com/BNETDocs/bnetdocs-web/tree/redux).
1010

11-
## Installation
12-
13-
### Clone this repository
14-
```sh
15-
git clone [email protected]:BNETDocs/bnetdocs-web.git ~/bnetdocs-web
16-
```
17-
18-
### Install nginx
19-
Follow the guide available over at
20-
[carlbennett/nginx-conf](https://github.com/carlbennett/nginx-conf).
21-
22-
After successfully installing **carlbennett/nginx-conf**, run:
23-
24-
```sh
25-
sudo cp ./etc/nginx-vhost-sample.conf \
26-
/etc/nginx/sites-available/local.bnetdocs.org.conf
27-
sudo ln -s \
28-
/etc/nginx/sites-available/local.bnetdocs.org.conf \
29-
/etc/nginx/sites-enabled/
30-
```
31-
32-
After running the above, modify the new file to your liking. It's recommended
33-
to update the `server_name` directives to `local.bnetdocs.org`. Please look
34-
over the file and perform any updates to it as you see fit.
35-
36-
### Install php-fpm
37-
#### CentOS 7.x / Fedora 24
38-
```sh
39-
sudo yum install php-fpm
40-
```
41-
42-
\* Use `dnf` instead of `yum` if you have it available.
43-
44-
#### Debian / Ubuntu
45-
```sh
46-
sudo apt-get update && sudo apt-get install php-fpm
47-
```
48-
49-
### Satisfy composer
50-
Run `composer install` at the root of the repository.
51-
52-
### Run nginx and php-fpm
53-
#### CentOS 7.x / Fedora 24
54-
```sh
55-
sudo systemctl start nginx php-fpm
56-
```
57-
58-
#### Debian / Ubuntu
59-
```sh
60-
sudo /etc/init.d/nginx start && sudo /etc/init.d/php-fpm start
61-
```
62-
63-
### Import sample database
64-
```sh
65-
mysql < ./etc/database.sample.sql
66-
```
67-
68-
### Configure BNETDocs
69-
```sh
70-
cp ./etc/config.sample.json ./etc/config.phoenix.json
71-
```
72-
73-
\* Open `config.phoenix.json` in your favorite text editor and modify it to
74-
your liking.
75-
76-
### Test
77-
Try accessing this endpoint: [local.bnetdocs.org](https://local.bnetdocs.org)
78-
79-
\* You may need to modify your `/etc/hosts` file if your development
80-
environment is not your `localhost`.
81-
8211
## Contributing
8312
Please read the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
8413

0 commit comments

Comments
 (0)