Skip to content

Commit 0cd357b

Browse files
committed
2 parents db627d3 + 4c1dc6d commit 0cd357b

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,26 @@ RawPHP comes with complete user authentication system built-in and ready to use
1212
## Installation
1313
There are two ways to install RawPHP:
1414

15-
* The first way is to clone `https://github.com/rawphp-framework/rawphp.git` into your local machine, then CD into it and run `composer install` in your command line. If you don't have composer already installed in your system, do download and installed [Composer](https://getcomposer.org/) .
16-
17-
* The second way is to use [Composer](https://getcomposer.org/) to install RawPHP.
18-
Navigate to the folder you wish to install RawPHP, then run the below code in your command line
15+
* The first way, (recommended) is to use [Composer](https://getcomposer.org/) to install RawPHP.
16+
Navigate to the folder in your computer where you wish to install RawPHP, then run the below code in your command line
1917
```
20-
$ composer require partner/rawphp
18+
$ composer create-project --prefer-dist partner/rawphp
2119
```
2220

21+
* The second way (only use this if the first method doesn't work for you) is to clone `https://github.com/rawphp-framework/rawphp.git` into your local machine, then CD into it and run `composer install` in your command line. If you don't have composer already installed in your system, do download and installed [Composer](https://getcomposer.org/) .
22+
2323

2424
Both methods install RawPHP and all required dependencies. RawPHP requires PHP 5.5.0 or newer.
2525

2626
## Usage
2727

2828
There are two ways to run RawPHP
29-
### PHP's inbuilt server
29+
30+
### Running your app
3031
After RawPHP has installed, you can run it by using the built-in PHP server. Navigate to the root folder and run the below command:
31-
```bash
32+
```
3233
$ php -S localhost:8000 -t public
34+
3335
```
3436
Going to http://localhost:8000/ will now display your default Homepage.
3537

@@ -39,6 +41,9 @@ Otherwise, you can just put it in your wamp/www or xxamp htdocs folder and acces
3941

4042
For more information on how to configure your web server, see the [Documentation](https://www.slimframework.com/docs/start/web-servers.html).
4143

44+
## Join RawPHP Mailing List (Recommended)
45+
Join [this mailing list](http://eepurl.com/cXRGdD)
46+
4247
## Tests
4348

4449
To execute the test suite, you'll need phpunit.
@@ -48,20 +53,21 @@ $ phpunit
4853
```
4954

5055
Now you have a copy of RawPHP and it's working fine, you'll need to setup your RawPHP database to complete this installation. The full [installation instructions are here](https://github.com/rawphp-framework/rawphp-docs/blob/master/docs/start/installation.md) . Enjoy.
56+
57+
## Documentation
58+
Below is the link to the documentation and tutorials
59+
60+
- [Documentation](https://github.com/rawphp-framework/rawphp-docs)
61+
- [Sample blog application tutorial](https://github.com/rawphp-framework/RawPHP-docs/blob/master/docs/tutorial/first-app.md)
62+
- Build a Job recruitment platform using this [Youtube Video Tutorials](https://www.youtube.com/watch?v=hzRXYrdR4m0&list=PLnBvgoOXZNCM_cxMH8rhLVch_YQbUL5el)
63+
- [Website](https://github.com/rawphp-framework/rawphp-website)
64+
65+
5166
## Contributing
67+
If you make any tutorial on RawPHP, please [report it as an issue](https://github.com/rawphp-framework/rawphp/issues) so we can add it to one of the resources.
5268

5369
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
5470

55-
## Learn More
56-
Since RawPHP was built using the best parts of CakePHP, Laravel and Slim, you can always consult the documentation of any of them to learn more about RawPHP
57-
You can also create an issue on this repo to get better clarifications if you have any questions.
58-
Learn more at these links:
59-
60-
- [Website](https://www.slimframework.com)
61-
- [Documentation](https://www.slimframework.com/docs/start/installation.html)
62-
- [Support Forum](http://discourse.slimframework.com)
63-
- [Twitter](https://twitter.com/slimphp)
64-
- [Resources](https://github.com/xssc/awesome-slim)
6571

6672
## Security
6773

0 commit comments

Comments
 (0)