-
Notifications
You must be signed in to change notification settings - Fork 125
feat: Prepare readme template #15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+69
−0
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <!-- Name your function --> | ||
| # ⚡ Template Function | ||
|
|
||
| <!-- Write short function tagline --> | ||
| Function with missing description. | ||
|
|
||
| ## 🧰 Usage | ||
|
|
||
| <!-- Copy section for each endpoint --> | ||
| <!-- Document endpoint method and url --> | ||
| ### `GET /` | ||
|
|
||
| <!-- Describe the endpoint --> | ||
| Endpoint with missing description. | ||
|
Meldiron marked this conversation as resolved.
Outdated
|
||
|
|
||
| **Parameters** | ||
| <!-- Document each expected parameter --> | ||
| | Name | Description | Location | Type | Sample Value | | ||
| |--------|---------------------------------|------------------------------|------------------------------------|--------------| | ||
| | userId | Param with missing description. | Path / Query / Body / Header | String / Number / Boolean / Object | 642...7cd | | ||
|
|
||
| **Response** | ||
|
|
||
| <!-- Provide sample body for successful response --> | ||
|
|
||
| Sample `200` Response: | ||
|
|
||
| ```json | ||
| { "ok": true } | ||
| ``` | ||
|
|
||
| <!-- If relevant, document error responses --> | ||
|
|
||
| Sample `400` Response: | ||
|
|
||
| ```json | ||
| { "ok": false, "message": "Missing userId parameter." } | ||
| ``` | ||
|
|
||
| ## ⚙️ Configuration | ||
|
|
||
| <!-- Update values and remove irelevant settings --> | ||
|
Meldiron marked this conversation as resolved.
Outdated
|
||
| | Setting | Value | | ||
| |----------------|----------------| | ||
| | Runtime | Node (18.0) | | ||
| | Entrypoint | src/main.js | | ||
| | Build Commands | npm run build | | ||
| | Permissions | any | | ||
| | Events | users.*.create | | ||
| | CRON | 0 * * * * | | ||
| | Timeout | 15 (Seconds) | | ||
|
|
||
| ## 🔒 Environment Variables | ||
|
|
||
| <!-- Copy section for each variable --> | ||
| <!-- Name the variable --> | ||
| ### APPWRITE_API_KEY | ||
|
|
||
| <!-- Describe the variable --> | ||
| API Key to talk to Appwrite backend APIs. | ||
|
|
||
| <!-- Mark if variable is required or not --> | ||
| <!-- Provide sample (but invalid) value --> | ||
| <!-- Link to docs or remove if irelevant --> | ||
|
Meldiron marked this conversation as resolved.
Outdated
|
||
| | Question | Answer | | ||
| |----------------|-----------------| | ||
| | Required | Yes / No | | ||
| | Sample Value | `d1efb...aec35` | | ||
| | Documentation | [Appwrite: Getting Started for Server](https://appwrite.io/docs/getting-started-for-server#apiKey) | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.