rawheel / myunfollowers-app Goto Github PK

We recommend that every repo has a code of conduct. If you don’t feel comfortable creating your own Code of Conduct from scratch we highly recommend using one of the templates provided by GitHub. If you do use a template, please read through the template and ensure that you can and will abide by the Code of Conduct.

Please follow these instructions on how to add a Code of Conduct.

Issue templates are very helpful for a collaboration repo. When users identify a bug or want to add a new feature, you can provide templates so you can collect all the pertinent information you need to fix a bug or add a new feature.

We recommend creating a “Report Bug” and “Feature Request” issue template.

Some suggested prompts/questions you can add to a “Report Bug” template are:

• Briefly describe the bug
• What is the expected behavior?
• Please provide step by step instructions on how to reproduce the bug

Some suggested prompts/questions you can add to a “Feature Request” issue template are:

• Briefly describe your feature request
• What problem is this feature trying to solve?
• How do we know when the feature is complete?

Learn repos should have a LEARN.md file to teach another student how to build your project step by step. You can explain how to build your project with text, code snippets, images, or even short (5 minute) long video lessons. As the maintainer of a Learn repo, the LEARN.md file requires you to think critically about how to explain the building of your project and how to also make it engaging. We don't expect you to be an expert teacher, but we would like you to reflect on how difficult it was to get to your level of knowledge, and then provide friendly guidance to help other students to learn.

As the maintainer of a Collaborate repo, keeping Issues up-to-date will help the student community understand what they can do to contribute. Issues should vary by the easy (update documentation) to the difficult (add a new feature). The more involved you are, the more opportunities there are to collaborate.

Recommendations:

• Add issues of varying difficulty to the repo often.
• Generate issues even if you plan on solving them, so the repository appears as active.
• Contribute/commit often to the repo so it does not go stale.

In order to submit your project into CX you will need at least one issue, but we recommend more so other students have an idea on where to start.

Other than GitHub Topics, your description will be the primary way of catching the users eyes. Your repo description should be clear and concise. Ask yourself:

• In one sentence, how do I convey what my repo does?
• What type of users am I interested in attracting to my repo?
• If I was a user, what words or phrases might spark my interest?

Let's raid who unfollows you on GitHub. The app is developed using Python(Flask) Backend & Vuejs front end. 👻

I would recommend updating your description to be concise and clear about what your project does and why it is useful. Also, personal opinion, I am not a fan of the word "raid." The sentence, "Let's raid who unfollows you on GitHub" sounds aggressive, and is not very welcoming.

This issue consists of the implementation of the new design which is coupled with the following issues.

1. #12
2. #13

The outcome of this issue would be to have a new design implemented using of the following libraries which will give a maintainable architecture to the project.

As I worked on the project when I was learning frontend and didn't explore and considered UI libraries with really cool components. But now I've researched and listed a few libraries we can use or I've been using.

1. Vuetify docs

Vuetify is a complete UI framework built on top of Vue.js. It provides built-in fancy components and customized tags with material design.

2. Vuesax docs

Vuesax is a framework of UI components created with Vuejs to make projects easily and with a unique and pleasant style.

3. Tailwindcss docs

TailwindCSS gives you the tools and the standardization to build exactly what you. It should be used for styling.

4. Apexcharts docs

ApexCharts is a modern charting library that helps developers to create beautiful and interactive visualizations for web pages. It is the easiest and best visualization library we can use with vue.js for visualization of user stats.

My Suggestions are to use Vuesax with tailwindcss for now because they are really easy to set up and gives really cool components which could fulfill the requirements, Vuetify could be considered for the future when the scope of the project would be molding towards getting more analytics.

Right now it has a really basic UI theme with a bad user experience. So the new UI needs to be designed.

Breakdown of new UI

The main page
Main Page will have a search bar where the user can enter his GitHub username and right below it the platform should show the table with stats of the user and how many unfollowers and followers he has secondary feature would be to add visualization.

The flow of the platform

• User goes to the URL.
• Sees a page with a search bar where he can enter his GitHub username.
• After entering their username platform shows him his unfollowers and followers in the form of a table and visualizations.

Hey, there!

I have just tried this out, when I entered my username for the first time, it should be a message like that
Hey DeepakKumarKhatri your username and followers have been saved for the latter use.

After that I tried it again by refreshing the page, I was expecting it be showing my profile details like my followers, etc like that was mentioned in the readme but it is still showing me the same message
Hey DeepakKumarKhatri your username and followers have been saved for the latter use.

A README is often the first item a visitor will see when visiting your repository. From what I see with your current README, it looks good. I would recommend adding:

• A more thorough step by step for a user to clone and run this repo on their computer.
• A section explaining that folks can learn how to recreate your project in the LEARN.md file.
• A mention of your code of conduct.
• How to contribute to your project

Depending on the complexity of your project, you might be interested in creating a CONTRIBUTING.md file, but we recommend starting simple with the bullet points above, and once you start to see an increase in users interested in contributing, you should consider a CONTRIBUTING.md file so you don’t find yourself overwhelmed with questions from other users.

In Community Exchange, GitHub Topics will help the discoverability of your project.

I see that you already have great topics on your repository! If you happened to use any offers in the GitHub Student Developer Pack to build this project, I would recommend adding the name of the company who provided the offer to improve your discoverability.

If you did not use any additional offers and you are happy with the topics you have, feel free to close this issue. 👍

👋 Hi @rawheel ,

I am your GitHub mentor for the GitHub Education, Community Exchange (CX) project. I'll be collaborating with you on preparing your repo for CX.

You mentioned in your submission that you wanted to submit a Learn + Collaborate repo. This means that you would like to teach students, step by step, how to build this project as well as invite other students to collaborate and add features to this repo. I will generate issues, which will provide guidance on how to prepare your repo for a Learn + Collaborate CX submission on June 1, 2022.

This issue will serve as a tracking issue to track all issues related to CX. I recommend creating a new branch for every issue and opening a pull request to track changes so we can effectively collaborate with each other and merge changes when you and I feel like those changes are ready to be merged on your primary branch.

If you have any questions or concerns, please feel free to leave a comment on this issue or any of the other issues that are generated.

I look forward to working with you

CX Issues

• #5
• #6
• #7
• #8
• #9
• #10
• #11