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

*Appwrite Content* - Help us create & improve docs, examples & tutorials #546

Open
eldadfux opened this issue Sep 21, 2020 · 43 comments
Open

*Appwrite Content* - Help us create & improve docs, examples & tutorials #546

eldadfux opened this issue Sep 21, 2020 · 43 comments

Comments

@eldadfux
Copy link
Member

@eldadfux eldadfux commented Sep 21, 2020

We have started deploying multiple examples repos for different platforms to the Appwrite org namespace. This repos contain different Appwrite demos, examples and tutorials for getting started with Appwrite.

Currently the main focus for this repos is around examples for platforms like: Angular, Vue.JS, React, Svetle & Flutter, tutorials for using different Appwrite features (OAuth) and different deployment methods.

This is a great way to both start playing around with Appwrite and to contribute to our open-source project.

Feel free to suggest ideas for more types of content as a comment to this issue.

General Notes

  • Use valid markdown for all content
  • Markdown file name should be in this format: my-new-appwrite-tutorials/README.md
  • Add markdown alt attribute for all images
  • Include only images with specific size (1200x800px) in PNG format
  • Include all images in the same directory as your markdown file For example: my-new-appwrite-tutorials/image-1.png

Vue.js

Add all tutorials in this repo: https://github.com/appwrite/demos-for-vue at root directory

TODO List:

Svetle

Add all tutorials in this repo: https://github.com/appwrite/demos-for-svetle at root directory

TODO List:

  • Simple login example and tutorial (@PineappleIOnic)
  • Simple Database examples and tutorial
  • Simple storage file upload example and tutorial
  • Simple image cropping examples and tutorial
  • Simple usage examples for the Appwrite Locale API
  • Simple usage examples for the Appwrite Avatars API

Angular

Add all tutorials in this repo: https://github.com/appwrite/demos-for-angular at root directory

TODO List:

React

Add all tutorials in this repo: https://github.com/appwrite/demos-for-react at root directory

TODO List:

Features

Add all tutorials in this repo: https://github.com/appwrite/appwrite at this location: docs/oauth

  • Login with Facebook + Appwrite OAuth API
  • Login with Github + Appwrite OAuth API
  • Login with Google + Appwrite OAuth API (@relaxxpls)
  • Monitor your Appwrite server with the Health API

Deployment

Add all tutorials in this repo: https://github.com/appwrite/appwrite at this location: docs/deployment

  • Deploy Appwrite on AWS (@dannylwe)
  • Deploy Appwrite on GCP (@Sameerkash)
  • Deploy Appwrite on Azure
  • Deploy Appwrite on DigitalOcean
  • Deploy Appwrite on Linode
  • Deploy Appwrite on Vultr
  • Deploy Appwrite on K8 (@Sameerkash)
  • Deploy Appwrite on Docker Swarm
  • Connect Appwrite with a managed DB solution
  • Deploy Appwrite without ClamAV
  • Deploy Appwrite with Sendgrid as an SMTP server
  • Deploy Appwrite with MailGun as an SMTP server
@eldadfux eldadfux changed the title *Appwrite Content* - Help us create & improve Appwrite docs, examples & tutorials *Appwrite Content* - Help us create & improve docs, examples & tutorials Sep 21, 2020
@eldadfux eldadfux added this to In progress in Ongoing (Help Wanted)! Sep 21, 2020
@eldadfux eldadfux pinned this issue Sep 21, 2020
@Niweera
Copy link
Member

@Niweera Niweera commented Sep 22, 2020

@eldadfux I would like to contribute to Simple Database examples and tutorial in React.

@jagdishjadeja
Copy link

@jagdishjadeja jagdishjadeja commented Sep 22, 2020

@eldadfux I would like to contribute to Simple Database examples and tutorial in angular

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Sep 22, 2020

@jagdishjadeja got you assigned

@benceHornyak
Copy link
Member

@benceHornyak benceHornyak commented Sep 24, 2020

@eldadfux Angular and AngularJS can be very confusing, they are two completely different framework. If you want I can contribute with Angular (2+, not JS).

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Sep 24, 2020

@benceHornyak, I fixed the FW name in the issue. Feel free to send any Angular PRs at: https://github.com/appwrite/demos-for-angular

@benceHornyak
Copy link
Member

@benceHornyak benceHornyak commented Sep 25, 2020

@eldadfux I'd love to contribute to Simple storage file upload example and tutorial in angular for hacktoberfest

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Sep 25, 2020

@benceHornyak that's great, I assigned you to the issue.

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Sep 25, 2020

Just added 2 new tutorials on the checklist:

  • Deploy Appwrite with Sendgrid as an SMTP server
  • Deploy Appwrite with MailGun as an SMTP server
@divyake
Copy link

@divyake divyake commented Sep 25, 2020

@eldadfux I would like to contribute to Simple storage file upload example and tutorial in react for hacktoberfest

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Sep 25, 2020

@divyake, I got you assigned.

@Ninjavin
Copy link

@Ninjavin Ninjavin commented Sep 26, 2020

@eldadfux I would like to contribute to Simple image cropping examples and tutorial in React for Hacktoberfest

@spiritbro1
Copy link

@spiritbro1 spiritbro1 commented Sep 26, 2020

@eldadfux I would like to contribute to Simple image cropping examples and tutorial in React

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Sep 26, 2020

@spiritbro1 you have been assigned to Simple image cropping examples and tutorial in React

@dannylwe
Copy link

@dannylwe dannylwe commented Sep 27, 2020

Hi, I'd like to contribute to Deploy Appwrite on AWS

@KarenEfereyan
Copy link

@KarenEfereyan KarenEfereyan commented Sep 29, 2020

@eldafux I am still trying to understand this issue and how I can make contributions? Mind explaining it further?

@iamsaquib8
Copy link

@iamsaquib8 iamsaquib8 commented Sep 29, 2020

@eldadfux I would like to contribute to Simple Database examples and tutorial in Svelte

@PineappleIOnic
Copy link
Member

@PineappleIOnic PineappleIOnic commented Sep 30, 2020

Hey, 👋 I'm currently working on a Database Example and a File Upload example for VueJS, Could I please be assigned to those tasks if they are still available?

@PineappleIOnic
Copy link
Member

@PineappleIOnic PineappleIOnic commented Sep 30, 2020

and I would also like to be removed from Simple login example and tutorial on Angular, Since I would prefer to devote more attention to VueJS, Svelte and React.

@relaxxpls
Copy link

@relaxxpls relaxxpls commented Oct 1, 2020

Could I add tutorials on Logging in with various services, I'm almost done with the documentation for google.

@eldadfux
Copy link
Member Author

@eldadfux eldadfux commented Oct 1, 2020

@PineappleIOnic I added you to the Vue.js tutorials, removed the Angular one.

@relaxxpls I added you to the Google login tutorial, let me know if you want to add more OAuth tutorials, we can also extend the list.

@drcoolsanjeev
Copy link

@drcoolsanjeev drcoolsanjeev commented Oct 1, 2020

@eldadfux I would like to contribute to Simple Database examples and tutorial in React

@spiritbro1
Copy link

@spiritbro1 spiritbro1 commented Oct 1, 2020

image

@drcoolsanjeev there is already somebody assigned to do that please pick another issue pick some issue that doesnt have @ in it

@Hard-Coder05
Copy link

@Hard-Coder05 Hard-Coder05 commented Oct 1, 2020

@eldadfux Just wanted to know if there is anything related to flutter that I can help in?

@ShubhamSood1406
Copy link

@ShubhamSood1406 ShubhamSood1406 commented Oct 1, 2020

@eldadfux Can I work on Login with Facebook + Appwrite OAuth API

@benceHornyak
Copy link
Member

@benceHornyak benceHornyak commented Oct 1, 2020

hey 👋 @eldadfux I'll happily take over Simple login example and tutorial for Angular.

@k-guy-dev
Copy link

@k-guy-dev k-guy-dev commented Oct 1, 2020

Hey @eldadfux I would really like to take a shot at Appwrite Locale API example for React.

@PineappleIOnic
Copy link
Member

@PineappleIOnic PineappleIOnic commented Oct 1, 2020

Could I get assigned to: Simple image cropping examples and tutorial for Vue? I have completed the previous two tasks and just awaiting a merge for them 👍

@naman360
Copy link

@naman360 naman360 commented Oct 1, 2020

I want to work on Simple usage examples for the Appwrite Avatars API for React.

@spiritbro1
Copy link

@spiritbro1 spiritbro1 commented Oct 1, 2020

@eldadfux i want to get assigned into Deploy Appwrite on DigitalOcean

@BalgopalPatro
Copy link

@BalgopalPatro BalgopalPatro commented Oct 2, 2020

@eldadfux I want to create a one-to-one Chat Application in React

@spielers
Copy link
Member

@spielers spielers commented Oct 5, 2020

@eldadfux I would like to contribute to Simple Database examples and tutorial in Svelte

hey, @drcoolsanjeev Go for it I am assigning you That

@spielers
Copy link
Member

@spielers spielers commented Oct 5, 2020

@eldadfux I want to create a one-to-one Chat Application in React

@BalgopalPatro that would be great but make proper documentation of start-to-end process of it .

Best,
spielers

@spielers
Copy link
Member

@spielers spielers commented Oct 5, 2020

@eldadfux I want to get assigned to Deploy Appwrite on DigitalOcean

Hey, @spiritbro1 You can work on this let me know when you're done!

@spielers
Copy link
Member

@spielers spielers commented Oct 5, 2020

hey 👋 @eldadfux I'll happily take over Simple login example and tutorial for Angular.

@benceHornyak Go for it I will assign your name to that

@spielers
Copy link
Member

@spielers spielers commented Oct 5, 2020

Hey @eldadfux I would really like to take a shot at Appwrite Locale API example for React.

Hey, @k-guy-dev Go for it I will assign your name

@KarenEfereyan
Copy link

@KarenEfereyan KarenEfereyan commented Oct 5, 2020

@spielers for us who have submitted PRS have they been reviewed?

@spielers
Copy link
Member

@spielers spielers commented Oct 5, 2020

@KarenEfereyan Yeah definitely it would be reviewed! :)

Best,
spielers

@spiritbro1
Copy link

@spiritbro1 spiritbro1 commented Oct 5, 2020

@Kolkies
Copy link
Member

@Kolkies Kolkies commented Oct 5, 2020

for us who have submitted PRS have they been reviewed?
@KarenEfereyan I can't find any PR from you in the appwrite organisation?

@avats-dev
Copy link

@avats-dev avats-dev commented Oct 5, 2020

@spielers @Kolkies Can I add deployment docs for heroku and IBMCloud, but these two are not mentioned in the above TODO? Thanks, let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Ongoing (Help Wanted)!
  
In progress
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
You can’t perform that action at this time.