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
Original file line number
Diff line number
Diff line change
@@ -43,9 +43,14 @@ Run [Composer](https://getcomposer.org/) to install all dependencies.
43
43
composer install --prefer-dist
44
44
```
45
45
46
-
Ensure the folder ./storage are with all rights to save log and cache (alread set in composer install, but ...)
46
+
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:
47
47
```sh
48
-
chmod -R 777 ./storage
48
+
mkdir storage/framework \
49
+
&& mkdir storage/framework/cache \
50
+
&& mkdir storage/framework/cache/data \
51
+
&& mkdir storage/framework/sessions \
52
+
&& mkdir storage/framework/views \
53
+
&& chmod -R 777 ./storage
49
54
```
50
55
51
56
To check the build for this project look at ./ops/docker/dev folder.
@@ -70,12 +75,6 @@ Now you can access the health-check [http://localhost:8101](http://localhost:810
70
75
}
71
76
```
72
77
73
-
### Requests samples
74
-
75
-
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`.
76
-
77
-
Not all requests are documented yet (Work in progress)
78
-
79
78
### Creating your automatic crud domain
80
79
81
80
For create your brand new domain with a complete crud use the command:
@@ -105,6 +104,38 @@ This command will create a folder in `app/Domains`, new files in `routes`, `data
105
104
php artisan migration
106
105
```
107
106
107
+
### Requests samples
108
+
109
+
Within the `/ops/requests` folder, you'll discover a collection of sample requests showcasing.
110
+
111
+
Requests have been meticulously documented in three different formats for your convenience:
112
+
113
+
1. Postman Collections
114
+
115
+
Files: `postman_collection.json` and `postman_environments.json`
116
+
117
+
Tool: Postman
118
+
119
+
These collections provide a comprehensive overview of the available API requests. Import them into Postman to explore and execute requests seamlessly.
120
+
121
+
122
+
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.
129
+
130
+
131
+
3. CURL Commands:
132
+
133
+
File: `requests.curl`
134
+
135
+
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.
136
+
137
+
Choose the documentation format that aligns with your preferred workflow and start seamlessly interacting with the API.
138
+
108
139
### Ulid
109
140
110
141
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