Skip to content

Commit

Permalink
fixed readme instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
@johndavedecano
johndavedecano committed Sep 14, 2018
1 parent 845d5f3 commit bee86d8
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 44 deletions.
88 changes: 44 additions & 44 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ $ php artisan serve

```base
$ cd project/resources/apps/frontend
$ cp .env.example .env # edit this file accordingly
$ npm install
$ npm run start
```
Expand All @@ -45,55 +46,54 @@ If you want to contribute to this project, feel free to do it and open a PR. How

In order to run tests:

* create a `homestead_test` database on your machine;
* run `phpunit`;
- create a `homestead_test` database on your machine;
- run `phpunit`;

If you want to specify a different name for the test database, don't forget to change the value in the `phpunix.xml` file.


## Routes

| Method | URI | Name | Action | Protected | Version(s) |
|-----------|-----------------------------------|-----------------------|----------------------------------------------------------------|-----------|------------|
| POST | /api/auth/signup | | App\Api\V1\Controllers\SignUpController@signUp | No | v1 |
| POST | /api/auth/login | | App\Api\V1\Controllers\LoginController@login | No | v1 |
| POST | /api/auth/recovery | | App\Api\V1\Controllers\ForgotPasswordController@sendResetEmail | No | v1 |
| POST | /api/auth/reset | | App\Api\V1\Controllers\ResetPasswordController@resetPassword | No | v1 |
| POST | /api/auth/logout | | App\Api\V1\Controllers\LogoutController@logout | No | v1 |
| POST | /api/auth/refresh | | App\Api\V1\Controllers\RefreshController@refresh | No | v1 |
| GET | /api/me | | App\Api\V1\Controllers\UserController@me | No | v1 |
| GET | /api/cycles | cycles.index | App\Api\V1\Controllers\CycleController@index | No | v1 |
| POST | /api/cycles | cycles.store | App\Api\V1\Controllers\CycleController@store | No | v1 |
| GET | /api/cycles/{cycle} | cycles.show | App\Api\V1\Controllers\CycleController@show | No | v1 |
| PUT | /api/cycles/{cycle} | cycles.update | App\Api\V1\Controllers\CycleController@update | No | v1 |
| DELETE | /api/cycles/{cycle} | cycles.destroy | App\Api\V1\Controllers\CycleController@destroy | No | v1 |
| GET | /api/services | services.index | App\Api\V1\Controllers\ServiceController@index | No | v1 |
| POST | /api/services | services.store | App\Api\V1\Controllers\ServiceController@store | No | v1 |
| GET | /api/services/{service} | services.show | App\Api\V1\Controllers\ServiceController@show | No | v1 |
| PUT | /api/services/{service} | services.update | App\Api\V1\Controllers\ServiceController@update | No | v1 |
| DELETE | /api/services/{service} | services.destroy | App\Api\V1\Controllers\ServiceController@destroy | No | v1 |
| GET | /api/packages | packages.index | App\Api\V1\Controllers\PackageController@index | No | v1 |
| POST | /api/packages | packages.store | App\Api\V1\Controllers\PackageController@store | No | v1 |
| GET | /api/packages/{package} | packages.show | App\Api\V1\Controllers\PackageController@show | No | v1 |
| PUT | /api/packages/{package} | packages.update | App\Api\V1\Controllers\PackageController@update | No | v1 |
| DELETE | /api/packages/{package} | packages.destroy | App\Api\V1\Controllers\PackageController@destroy | No | v1 |
| GET | /api/users | users.index | App\Api\V1\Controllers\UserController@index | No | v1 |
| POST | /api/users | users.store | App\Api\V1\Controllers\UserController@store | No | v1 |
| GET | /api/users/{user} | users.show | App\Api\V1\Controllers\UserController@show | No | v1 |
| PUT | /api/users/{user} | users.update | App\Api\V1\Controllers\UserController@update | No | v1 |
| DELETE | /api/users/{user} | users.destroy | App\Api\V1\Controllers\UserController@destroy | No | v1 |
| GET | /api/activities | activities.index | App\Api\V1\Controllers\ActivityController@index | No | v1 |
| POST | /api/activities | activities.store | App\Api\V1\Controllers\ActivityController@store | No | v1 |
| GET | /api/activities/{activity} | activities.show | App\Api\V1\Controllers\ActivityController@show | No | v1 |
| PUT | /api/activities/{activity} | activities.update | App\Api\V1\Controllers\ActivityController@update | No | v1 |
| DELETE | /api/activities/{activity} | activities.destroy | App\Api\V1\Controllers\ActivityController@destroy | No | v1 |
| GET | /api/subscriptions | subscriptions.index | App\Api\V1\Controllers\SubscriptionController@index | No | v1 |
| POST | /api/subscriptions | subscriptions.store | App\Api\V1\Controllers\SubscriptionController@store | No | v1 |
| GET | /api/subscriptions/{subscription} | subscriptions.show | App\Api\V1\Controllers\SubscriptionController@show | No | v1 |
| PUT | /api/subscriptions/{subscription} | subscriptions.update | App\Api\V1\Controllers\SubscriptionController@update | No | v1 |
| DELETE | /api/subscriptions/{subscription} | subscriptions.destroy | App\Api\V1\Controllers\SubscriptionController@destroy | No | v1 |
| POST | /api/upload | | App\Api\V1\Controllers\ImageController@store | No | v1 |
| GET | /api/refresh | | Closure | No | v1 |
| Method | URI | Name | Action | Protected | Version(s) |
| ------ | --------------------------------- | --------------------- | -------------------------------------------------------------- | --------- | ---------- |
| POST | /api/auth/signup | | App\Api\V1\Controllers\SignUpController@signUp | No | v1 |
| POST | /api/auth/login | | App\Api\V1\Controllers\LoginController@login | No | v1 |
| POST | /api/auth/recovery | | App\Api\V1\Controllers\ForgotPasswordController@sendResetEmail | No | v1 |
| POST | /api/auth/reset | | App\Api\V1\Controllers\ResetPasswordController@resetPassword | No | v1 |
| POST | /api/auth/logout | | App\Api\V1\Controllers\LogoutController@logout | No | v1 |
| POST | /api/auth/refresh | | App\Api\V1\Controllers\RefreshController@refresh | No | v1 |
| GET | /api/me | | App\Api\V1\Controllers\UserController@me | No | v1 |
| GET | /api/cycles | cycles.index | App\Api\V1\Controllers\CycleController@index | No | v1 |
| POST | /api/cycles | cycles.store | App\Api\V1\Controllers\CycleController@store | No | v1 |
| GET | /api/cycles/{cycle} | cycles.show | App\Api\V1\Controllers\CycleController@show | No | v1 |
| PUT | /api/cycles/{cycle} | cycles.update | App\Api\V1\Controllers\CycleController@update | No | v1 |
| DELETE | /api/cycles/{cycle} | cycles.destroy | App\Api\V1\Controllers\CycleController@destroy | No | v1 |
| GET | /api/services | services.index | App\Api\V1\Controllers\ServiceController@index | No | v1 |
| POST | /api/services | services.store | App\Api\V1\Controllers\ServiceController@store | No | v1 |
| GET | /api/services/{service} | services.show | App\Api\V1\Controllers\ServiceController@show | No | v1 |
| PUT | /api/services/{service} | services.update | App\Api\V1\Controllers\ServiceController@update | No | v1 |
| DELETE | /api/services/{service} | services.destroy | App\Api\V1\Controllers\ServiceController@destroy | No | v1 |
| GET | /api/packages | packages.index | App\Api\V1\Controllers\PackageController@index | No | v1 |
| POST | /api/packages | packages.store | App\Api\V1\Controllers\PackageController@store | No | v1 |
| GET | /api/packages/{package} | packages.show | App\Api\V1\Controllers\PackageController@show | No | v1 |
| PUT | /api/packages/{package} | packages.update | App\Api\V1\Controllers\PackageController@update | No | v1 |
| DELETE | /api/packages/{package} | packages.destroy | App\Api\V1\Controllers\PackageController@destroy | No | v1 |
| GET | /api/users | users.index | App\Api\V1\Controllers\UserController@index | No | v1 |
| POST | /api/users | users.store | App\Api\V1\Controllers\UserController@store | No | v1 |
| GET | /api/users/{user} | users.show | App\Api\V1\Controllers\UserController@show | No | v1 |
| PUT | /api/users/{user} | users.update | App\Api\V1\Controllers\UserController@update | No | v1 |
| DELETE | /api/users/{user} | users.destroy | App\Api\V1\Controllers\UserController@destroy | No | v1 |
| GET | /api/activities | activities.index | App\Api\V1\Controllers\ActivityController@index | No | v1 |
| POST | /api/activities | activities.store | App\Api\V1\Controllers\ActivityController@store | No | v1 |
| GET | /api/activities/{activity} | activities.show | App\Api\V1\Controllers\ActivityController@show | No | v1 |
| PUT | /api/activities/{activity} | activities.update | App\Api\V1\Controllers\ActivityController@update | No | v1 |
| DELETE | /api/activities/{activity} | activities.destroy | App\Api\V1\Controllers\ActivityController@destroy | No | v1 |
| GET | /api/subscriptions | subscriptions.index | App\Api\V1\Controllers\SubscriptionController@index | No | v1 |
| POST | /api/subscriptions | subscriptions.store | App\Api\V1\Controllers\SubscriptionController@store | No | v1 |
| GET | /api/subscriptions/{subscription} | subscriptions.show | App\Api\V1\Controllers\SubscriptionController@show | No | v1 |
| PUT | /api/subscriptions/{subscription} | subscriptions.update | App\Api\V1\Controllers\SubscriptionController@update | No | v1 |
| DELETE | /api/subscriptions/{subscription} | subscriptions.destroy | App\Api\V1\Controllers\SubscriptionController@destroy | No | v1 |
| POST | /api/upload | | App\Api\V1\Controllers\ImageController@store | No | v1 |
| GET | /api/refresh | | Closure | No | v1 |

## Feedback

Expand Down
Binary file modified screenshot.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bee86d8

Please sign in to comment.