You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-8Lines changed: 39 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,9 +49,14 @@ Run [Composer](https://getcomposer.org/) to install all dependencies.
49
49
composer install --prefer-dist
50
50
```
51
51
52
-
Ensure the folder ./storage are with all rights to save log and cache (alread set in composer install, but ...)
52
+
Ensure the composer install create the cache folders and give then permissions in ./storage, if don't you'll have to create and give permitions yourself:
53
53
```sh
54
-
chmod -R 777 ./storage
54
+
mkdir storage/framework \
55
+
&& mkdir storage/framework/cache \
56
+
&& mkdir storage/framework/cache/data \
57
+
&& mkdir storage/framework/sessions \
58
+
&& mkdir storage/framework/views \
59
+
&& chmod -R 777 ./storage
55
60
```
56
61
57
62
To check the build for this project look at ./ops/docker/dev folder.
@@ -76,12 +81,6 @@ Now you can access the health-check [http://localhost:8101](http://localhost:810
76
81
}
77
82
```
78
83
79
-
### Requests samples
80
-
81
-
You can find a sample of requests you can do in the file `requests.http` (for the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension on VSCode) or using curl commands listed in the file `requests.curl`.
82
-
83
-
Not all requests are documented yet (Work in progress)
84
-
85
84
### Creating your automatic crud domain
86
85
87
86
For create your brand new domain with a complete crud use the command:
@@ -111,6 +110,38 @@ This command will create a folder in `app/Domains`, new files in `routes`, `data
111
110
php artisan migration
112
111
```
113
112
113
+
### Requests samples
114
+
115
+
Within the `/ops/requests` folder, you'll discover a collection of sample requests showcasing.
116
+
117
+
Requests have been meticulously documented in three different formats for your convenience:
118
+
119
+
1. Postman Collections
120
+
121
+
Files: `postman_collection.json` and `postman_environments.json`
122
+
123
+
Tool: Postman
124
+
125
+
These collections provide a comprehensive overview of the available API requests. Import them into Postman to explore and execute requests seamlessly.
126
+
127
+
128
+
2. Visual Studio Code (VSCode) REST Client Extension:
With the extension installed in VSCode open the `requests.http` file. This extension allows you to send HTTP requests directly from your code editor, making it easy to interact with the API.
135
+
136
+
137
+
3. CURL Commands:
138
+
139
+
File: `requests.curl`
140
+
141
+
For those who prefer the command line, CURL commands are provided in the `requests.curl` file. Execute these commands in your terminal to interact with the API using the widely-used CURL tool.
142
+
143
+
Choose the documentation format that aligns with your preferred workflow and start seamlessly interacting with the API.
144
+
114
145
### Ulid
115
146
116
147
For primary key value, this project using [Ulid](https://github.com/not-empty/ulid-php-lib) value, but you can pass other pattern in insert route if you prefer.
0 commit comments