Skip to content

Commit a52d2c8

Browse files
committed
Readme: add more thorough instructions and limit text width to 80 chars
1 parent 1b02f0e commit a52d2c8

File tree

1 file changed

+65
-15
lines changed

1 file changed

+65
-15
lines changed

README.md

Lines changed: 65 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,68 @@
11
# StackExchangeBackupLaravel
2-
Allows you to export JSON files of your most important data (questions, answers, comments, favorites) from each of your Stack Exchange sites (Stack Overflow, Super User, Server Fault, etc).
2+
3+
Allows you to export JSON files of your most important data (questions,
4+
answers, comments, favorites) from each of your Stack Exchange sites (Stack
5+
Overflow, Super User, Server Fault, etc).
36

47
## Installation
58

6-
1. I think this project requires PHP 7.3 or later, so be sure that your system complies.
7-
1. Sign up at https://stackapps.com/apps/oauth/register to receive a Client ID, Client Secret, and Key. (It's free, easy, and fast.)
8-
1. Create a Laravel project, and make sure that it works: https://laravel.com/docs/5.8/installation#installing-laravel
9-
1. Add this package into your Laravel project: `vagrant@vboxHomestead:~/Code/MyLaravelProject$ composer require ryancwalsh/stack-exchange-backup-laravel:dev-master --prefer-source`
10-
1. Run `php artisan vendor:publish`, and if it gives you a choice, choose to publish from this package.
11-
1. Edit your Laravel project's `.env` file to have your own StackApps values. A non-working sample is below.
12-
1. Run `php artisan exportStackExchange`. (Note that `php artisan exportStackExchange --flushCache` is an available option to clear the cached access code value.)
13-
1. Following the instructions in the terminal, you'll use your browser to visit a URL that will provide you with a temporary access token to paste into the terminal.
14-
1. Finished! The JSON files will appear in your `/storage/app/StackExchange` folder.
9+
There is no need to clone this repository, the installation works with _PHP
10+
composer_. It will install the _Laravel_ framework and add this project to the
11+
app.
12+
13+
1. This is only tested on PHP 7.3, so be sure that your system complies.
14+
15+
1. Sign up at https://stackapps.com/apps/oauth/register to receive a Client
16+
ID, Client Secret, and Key. (It's free, easy, and fast.)
17+
18+
1. Create a [Laravel project](https://laravel.com/docs/5.8/installation#installing-laravel)
19+
for this app, and make sure that it works:
20+
21+
mkdir ~/Code/Laravel
22+
cd ~/Code/Laravel
23+
composer global require laravel/installer
24+
# on Ubuntu 18.04 and Debian 9+:
25+
echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc
26+
# on other systems this might be
27+
# echo 'export PATH="$PATH:$HOME/.composer/vendor/bin"' >> ~/.bashrc
28+
# apply PATH:
29+
source ~/.bashrc
30+
# create the laravel project for this app:
31+
laravel new webapp
32+
33+
1. Add this package into your Laravel project in the parent folder of the app
34+
folder:
35+
36+
cd webapp/
37+
composer require ryancwalsh/stack-exchange-backup-laravel:dev-master --prefer-source
38+
39+
1. Run _artisan_, and choose to publish the "Provider" from this package:
40+
`ryancwalsh\StackExchangeBackupLaravel\ExportStackExchangeServiceProvider`
41+
42+
php artisan vendor:publish
43+
44+
1. Edit your Laravel project's `.env` file to have your own StackApps values. A
45+
non-working sample is below.
46+
47+
1. Run
48+
49+
php artisan exportStackExchange
50+
51+
(Note that `php artisan exportStackExchange --flushCache` is the option to
52+
clear the cached access codevalue.)
53+
54+
1. Following the instructions in the terminal, you'll use your browser to visit
55+
a URL that will provide you with a temporary access token to paste into the
56+
terminal.
57+
58+
1. Finished! The JSON files will appear in your `/storage/app/StackExchange`
59+
folder.
1560

1661
```
1762
# These are sample .env values:
18-
STACKAPPS_CLIENT_ID=12227
19-
STACKAPPS_CLIENT_SECRET=ydxGSDFHDF4DtZqCesr)yJIw((
20-
STACKAPPS_KEY=JuWsTgfG2CqjdghkhdgBkQ((
63+
STACKAPPS_CLIENT_ID=<your Client Id>
64+
STACKAPPS_CLIENT_SECRET=<your Client Secret>
65+
STACKAPPS_KEY=<your Key>
2166
AWS_ACCESS_KEY_ID=AKIAmb3mbn56mn6
2267
AWS_SECRET_ACCESS_KEY=jl234k5jl23k45j23lj5
2368
AWS_DEFAULT_REGION=us-east-1
@@ -27,12 +72,17 @@ AWS_BUCKET=xyz
2772

2873

2974
## If You Use This Package, Let Me Know!
30-
**This is the first package that I've ever made, and I'm super curious if anyone will ever use it. If you do try it out, I'd love for you to [open an issue](https://github.com/ryancwalsh/StackExchangeBackupLaravelPHP/issues/new) to say hi** (and of course to tell me any suggestions you have).
75+
**This is the first package that I've ever made, and I'm super curious if anyone
76+
will ever use it. If you do try it out, I'd love for you to [open an
77+
issue](https://github.com/ryancwalsh/StackExchangeBackupLaravelPHP/issues/new)
78+
to say hi** (and of course to tell me any suggestions you have).
3179

3280
___
3381

3482
### If You Want To Get Creative...
35-
Visit https://api.stackexchange.com/docs to read the docs, and you can modify `ExportStackExchangeHelper.php` to do whatever you want. The Stack Exchange API is great.
83+
Visit https://api.stackexchange.com/docs to read the docs, and you can modify
84+
`ExportStackExchangeHelper.php` to do whatever you want. The Stack Exchange API
85+
is great.
3686

3787

3888

0 commit comments

Comments
 (0)