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

Add more examples to the Wiki #11

Open
nombrekeff opened this issue Oct 14, 2023 · 7 comments
Open

Add more examples to the Wiki #11

nombrekeff opened this issue Oct 14, 2023 · 7 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@nombrekeff
Copy link
Owner

nombrekeff commented Oct 14, 2023

The wiki currently has only 2 examples: counter and todo app.

We should add as many examples as possible. Not only to showcase the project, but also to find bugs, missing features, or anything that could be improved!

Examples should also be created in the examples folder in the project. This way we can run and test them, and other users can also play with them!

Here is a list of some ideas for examples:

  • Calculator
  • Clock (already made in the examples folder, we just need to also add it to the Wiki)
  • TODO list with API (use a fake api or something like that)
  • Weather API app - make an app that fetches data from weather app and updates data dinamically
@nombrekeff nombrekeff added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Oct 14, 2023
@nombrekeff nombrekeff added this to the v1.0.0 milestone Oct 16, 2023
@Otomatyk
Copy link

Why not add the examples that you showed on dev.to ?

@nombrekeff
Copy link
Owner Author

Good call. I removed them from the readme because they made it way to messy, I've now added the examples to the Wiki.

There's just 2 examples currently, but I want to add as many as I can. Not only to showcase the project, but also to find bugs, problems, missing features, etc...

I will update the description and title of this message to better explain what it's about.

Here's my discord in case you have any question or want help with anything: nombrekeff. Feel free to reach out

@nombrekeff nombrekeff changed the title More examples Add more examples to the Wiki Oct 16, 2023
@Otomatyk
Copy link

When the bundler is ready (Should I say "When it will be" ?), I use it (For the moment I haven't used it yet, the complexity of the installation was too important for me) and add more example to the wiki or find bug

@nombrekeff
Copy link
Owner Author

I will take a look at the PR later. I'm now writing a couple of documents for contributing and settings up the project. I will share them here when I finish, they will explain the contributing process and how to setup the project for development!

@nombrekeff
Copy link
Owner Author

Here, you can find a little guide on how to contribute, and how to set up the project for development.

@Otomatyk
Copy link

Why you didn’t added the CONTRIBUTING.md file ?

@nombrekeff
Copy link
Owner Author

nombrekeff commented Oct 16, 2023

I usually do that and might consider adding one. But I don't like how cluttered the project becomes with so many files. It might be a good idea to have it though, as you can check it when working on the project! The project is in it's early stages, so all of this stuff will be improved and changed a few times in the future.

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants