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

📚 Documentation: Tutorial for Angular #219

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aakashraj01
Copy link
Contributor

What does this PR do?

Added Tutorial for a functioning app with Angular in the Docs

Test Plan

The Tutorial can be found in the route /docs/tutorials/angular/step-1

Related PRs and Issues

#81

Have you read the Contributing Guidelines on issues?

Yes

@vercel
Copy link

vercel bot commented Oct 9, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 28, 2023 6:20pm

@TorstenDittmann TorstenDittmann added the documentation Improvements or additions to documentation label Oct 18, 2023
@gewenyu99
Copy link
Contributor

@aakashraj01 Are you still working on this?

@aakashraj01
Copy link
Contributor Author

@aakashraj01 Are you still working on this?

Yes @gewenyu99 . I m still working and have done most of the review comment changes :)

@gewenyu99
Copy link
Contributor

@aakashraj01 Are you still working on this?

Yes @gewenyu99 . I m still working and have done most of the review comment changes :)

Don't forget to re-request review and make sure you build passes!

@aakashraj01
Copy link
Contributor Author

Hey @gewenyu99 . I have made all the changes as per your review comments suggestions. Please have a review over the PR :)

Copy link
Contributor

@gewenyu99 gewenyu99 left a comment

Choose a reason for hiding this comment

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

Hey, there's a lot of missing and incorrect information I found and could not properly follow the tutorial.

Please carefully follow your own tutorial from scratch and make sure it works so we can accept it in time for Hacktoberfest!

```ts
import { Injectable } from '@angular/core';
import { BehaviorSubject } from 'rxjs';
import { account } from './appwrite.service';
Copy link
Contributor

Choose a reason for hiding this comment

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

That path looks wrong

}

async register(email: string, password: string): Promise<void> {
await account.create(email, password);
Copy link
Contributor

Choose a reason for hiding this comment

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

This is missing arguments. account.create requires 3 arguments at minimum

}
```

Ensure you have the FormsModule imported in your `app.module.tsx` to use `[(ngModel)]` for two-way data binding.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please give more details here. Take inspiration from here:
https://appwrite.io/docs/quick-starts/angular#step-5

- A logout button if the user is logged in.
- A login button if the user is not logged in.

Update the `AppComponent` in `src/app/app.component.tsx`:
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't have this file. I have 3 files, are you missing setup instructions?
Screenshot 2023-10-29 at 4 40 32 PM

Copy link
Contributor

Choose a reason for hiding this comment

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

Also should we really use TSX? What is the recommended default for Angular, can we stick to it?

@Component({
selector: 'app-root',
template: `
<app-navbar></app-navbar> <!-- Add the navbar before page content -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing imports here.

@gewenyu99
Copy link
Contributor

Hey,

Due to time constraints, I'm going to mark this PR hacktoberfest-accepted for now so you get DO's Hacktoberfest rewards. We'll continue to work with you on this issue for review and merge.

When it is merged, we'll contact you for Appwrite-specific Hacktoberfest swag.

Thanks for helping us improve Appwrite!

@tessamero tessamero linked an issue Nov 2, 2023 that may be closed by this pull request
2 tasks
@tessamero
Copy link
Contributor

Hello @aakashraj01 ,

Thank you for your contribution to Hacktoberfest 2023! We've noticed that your PR is still pending and requires some updates based on our engineering team's feedback.

We would love to see your PR successfully merged and send you the Appwrite swag as a token of appreciation. To remain eligible for the swag, please address the pending suggestions and/or ensure the tests pass by Friday, November 17th. If the PR isn't updated by then, we will unfortunately have to close it due to the end of the Hacktoberfest event.

Looking forward to your updates and thank you!

@gewenyu99
Copy link
Contributor

Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship.

Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag.

@aakashraj01
Copy link
Contributor Author

Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship.

Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag.

Hey @gewenyu99 . My discord username is Aakash Raj#8138

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📚 Documentation: Tutorial for Angular
4 participants