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

App Development Project Readme Template #26

Open
its-navneet opened this issue Oct 2, 2022 · 1 comment
Open

App Development Project Readme Template #26

its-navneet opened this issue Oct 2, 2022 · 1 comment

Comments

@its-navneet
Copy link
Collaborator

Readme Creation👷

Create a README.md file in your folder, example Peter_Solutions/README.md.
Below are the points that are to be properly mentioned in your readme.

1. Project Explanation with Title🚀

Explain your project in short and precise way and if the app is solving any problem then briefly explain how it can be the solution to that problem.

2. Problem Solving🤯

  • Try to mention your project plans and implementation.
  • Put the screenshots of your app.
  • Be precise and try to maintain the required factors.

3. Mention the Tech - Stack 👨‍💻👩‍💻

Be precise and be as clear as possible with your tech - stack

Project submission

Based on the level and complicacy of the projects, you are advised to add your project folder for eg:- YOUR_NAME to the respective projects_Intermediate/APP_DEVELOPEMENT or projects_Advanced/APP_DEVELOPEMENT .
Your folder should contain following information:-

  • All the files and packages used in this projects.
  • The .gitignore file

The deciding factors for the level of your projects solely depends upon the technical stacks used in it. Below are some level
specific projects similar to which your projects will be considered or else will be rejected .

Intermediate level example (Frontend with logics and navigation components)

  • TIC TAC TOE GAME
  • CALCULATOR APP

Advanced level example (includes api calling using repositories and viewModels)

  • SOCIAL MEDIA APP
  • SHOPPING APP

Suggestion if any 📝

Tell us what better can be implemented

If new can refer to the following instructions and start contribution Contribution Guide 🤝

@realsahilsaini
Copy link

realsahilsaini commented Oct 2, 2022

hey @its-navneet, can work on this?
If yes, then please let me know what are you expecting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants