Skip to content
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

feat: Hello, World! function #1

Closed
wants to merge 15 commits into from
Closed

feat: Hello, World! function #1

wants to merge 15 commits into from

Conversation

loks0n
Copy link
Member

@loks0n loks0n commented Jul 10, 2023

What does this PR do?

Adds a basic Hello, World! function

Test Plan

You can run the function locally by creating the neccessary .env and executing npx appwrite-function-utils dev src/main.js

armang4.appwrite.org link:

Have you read the Contributing Guidelines on issues?

Yes

hello-world/src/main.js Outdated Show resolved Hide resolved
@@ -0,0 +1,13 @@
# Hello World Function
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love to give READMes structure. Ideally it should have all information developer would need to install it, configure it, and use it.

Here is my proposal, let me know what you think:

  1. Title
  2. Short description
  3. Installation Instructions
  • runtime (mention which it was tried on, mention others might or night not work)
  • env variables (name, isRequired, description, example value. If relevant, link to external docs)
  • entrypoint
  • build commands
  • recommended events (only if not empty)
  • recommended corn (only if not empty)
  • recommended timeout (only if not empty)
  • recommended permissions (only if not empty)
  1. How to use (like long description. document all possibilities - endpoints.. expected behaviour.. Like tests, but just written down)

Ideally we would have template README somewhere, so when we make new template, we use that as the base

hello-world/package.json Outdated Show resolved Hide resolved
hello-world/src/main.js Outdated Show resolved Hide resolved
hello-world/src/main.js Outdated Show resolved Hide resolved
@loks0n
Copy link
Member Author

loks0n commented Jul 19, 2023

closing in favour of starter template
#18

@loks0n loks0n closed this Jul 19, 2023
@loks0n loks0n deleted the feat-hello-world branch October 3, 2023 11:45
IgorJanGit pushed a commit to IgorJanGit/templates that referenced this pull request Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants