csdojo-defaang / defaang Goto Github PK

Description

Assuming we have #59, we should be able to show the questions on the UI.

Description

We should generate a username when a user signs up, and we should have an option for them to change it.

Description

Try to add a contriubting.md file explaining all the contributing guidelines.

Changes

• Add workflow for that which create auto-release and CHANGELOG file.
  Refer to this - https://github.com/TriPSs/conventional-changelog-action

Hello,
How will we validate that submitted questions are being asked in the interview or an anonymous user has just posted random questions?

I think the doc can be improve in many ways.

• Use semantic ordered list for the instructions, instead of #1 or #2
• Remove the comments which are in parentheses. As, if you click on the copy button, they also get copied. Bad UX.
• Add steps like cd <project-directory> to remove any confusion

For reference here's how tailwindcss.com does it.

It's simple & to the point. Any feedback is welcome.

Description

Setting up the project on a local machine is never fun. So I recently learned about GitPod, a pretty great service that allows us to work and contribute to projects directly from the browser.

Therefore, I want to include the GitPod button in this project.

Description

When a user signs up at /signup, confirming the email is required. I think we should make that clear.

Also, we should probably add some info about how to find the signup page (/signup) and the signin page (/signin) either on the site itself or in README.

I noticed almost all new issues don't have screenshots attached to them.

So we should probably remove the screenshot section from the new issue template so it doesn't clutter the new issues being created.

The dependencies are little behind the latest and we should use a specific version instead of "next": "latest", in package.json

This is probably a good place to start since we don't have any code in this repo yet.

We can probably use this: https://github.com/vercel/next.js/tree/4d4f3093019179b1928ec07c16f38882241c0375/examples/with-tailwindcss

Hi ykdogo, looking forward to work along you...

Description

Is this a brand new web application or do you guys implement something into cause when I cloned it . I am seeing a clean project with default screen.. I am new to open source and want to contribute.

Screenshots

No response

Description

We're most likely going to start using Tailwind UI for this project.

So we should rewrite the signup/singin view with maybe this one.

Assuming we go with Supabase, we should make a connection to it from our frontend, and document how to set up a SB account/database with it.

For the initial version, we could have something really simple, maybe like a counter? As in, you click a button and the number increases by one, or something like that.

Alternatively, we can set up a user signup/login form as in #14.

Hey everyone!

I was asked to create a discord server for this project... so I did!

I made an announcement in the discussions tab here: #15

Feel free to use the discussions tab and/or the discord to chat about and discuss this project!

Why already worrying about frameworks? Why not just go vanilla and build up from there? 🍦

Now that we have #28 merged, I think it'll make sense soon to document how to deploy it to Vercel.

Description

We are not live yet, but it's a good idea to add Hotjar script that will help analyse our apps performance and get feedbacks when we get to Beta or similar kind of stage.

Would love to know your suggestion.

Refer to the GitHub's official docs

Description

I think as we are using the next js we should use the next auth for the authentication parts. I think it will be easy and maintainable if we use it. Let me know what you think about it.

Since we removed the screenshot section in #43 and #46, we only have the description label in our issue templates for features and documentation.

Now that we've done that, the description label is redundant and unnecessary.

It'd be cleaner to remove it.

@rohitdasu created documentation on how to set up the local env in #28.

Another person should make sure that it works.

I'll do it when I get the chance, but if anyone else wants to take it before I get to it, feel free to do so.

The Vercel bot started acting out and keeps asking me to authorize some stuff:

We should probably contact them and ask them what's going on, or I'll look into it some more.

Description

Mods (once we have them) should be able to approve questions so that they can be shown on the UI.

Showing questions without approving them first, at least at the beginning, is probably a bad idea because we'll have low quality submissions, spams, etc.

An initial rough sketch of what the questions page of the website may look like. Attached is the initial rough sketch. I have numbered the boxes so I can provide more clarity regarding the functionality of each box and their purpose of why I have them included.

1. This could be a drop-down box where the user can select the specific company they want to view questions for or it could have an option of 'All' for all the FAANG companies.
2. I have assumed that this website is not only for software engineering interview questions and hence I included this field. The name could be improved upon, but as of now, for the sake of simplicity, I have named it Area of knowledge so the user can select whether he/she wants to view questions from all or specific companies regarding software engineering, and system design, frontend, etc. I hope that gives some clarity.
3. This box will contain the actual question itself. The sizing can be dynamic depending on the question's length.
4. This box will show the author of the question. Can be an 'Anonymous user' if the user who submitted the question wishes to keep their identity private. (We could maybe implement the google docs feature of random names instead of a simple 'anonymous user' for all users who choose to stay private when uploading their questions. We could have animal names or something like that to make it a little bit more creative and fun. Alternatively, if the user chooses to disclose their identity, the identity details will be shown in that box.
5. This box will show the expected complexity of the solution you must come up with. I am a little unsure about this but from what I have observed so far, many interviews expect candidates to have decent knowledge regarding the efficiency of their solution and if the user has an idea regarding the complexity of the solution expected in regards to their question, that can be displayed in that box. This box is questionable and up for debate whether it should be included or not.
6. the user who uploads the question can also add some hints/helpful tips for the solution if they feel it may be necessary or have the knowledge to do so. This will then be reflected in this box when the user who is viewing the question selects this box.
7. This is pretty obvious but it is the solution box. The user can find the full working solution when he selects this box.
8. This is a big space for the user to try their code if they want to. However, this box gives me mixed feelings. Maybe, we don't necessarily need this but it could be something that can be incorporated in the future.
   UI Mockup #1.pdf

DX = developer experience

Description

https://github.com/users/ykdojo/projects/1

Description

let's keep the instructions for running the frontend simple, so keep npm instructions only.

Screenshots

No response

Description

This is the backend portion of #59.

Description

We deploy this site to Vercel here, but it's just a starter template, and it doesn't say anything about the project.

Some people might be confused about that: #45

It'd be good to explain what this project is about there, even if it's a temporary thing.

Refer to the official GitHub's docs

Description

As we have started coding, we should use semantic commits. It helps a lot to reviewers who reviews the code, as well as the developer. It builds a good habit which makes us a better developer.

Ref: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716

Screenshots

No response

Here is the UX wireframe for the website, if ready to got with it will be issuing an UI too.

https://excalidraw.com/#json=R6Dr_C1S9JMKNl1lKVdkZ,5Cpg-gVKd0mzRfLXUfz9aA

Description

How about moving the installation instructions from README.md into a file like INSTALL.md?

This would allow README.md to be much more concise -- a project description, table of contents, and highly relevant links (Discord, etc.)

Description

I think we should decide the color palette for the website, so that people who working on UI make UI using those colors.
Also if we have fixed color palette then different different people who are working on UI won't come with the own color palettes.
So let's asks contributors to come up with their own color palette and decide one good color palette out of it.

Well there are many tools available to generate color palette for the website. We can also use them

What are your thoughts on this @ykdojo or do you have any preferred color scheme to move forward?

The current PR template has this checklist:

Check List (Check all the applicable boxes)

• My code follows the code style of this project.
• This PR does not contain plagiarized content.
• The title of my pull request is a short description of the requested changes.

Shouldn't all of these be pretty obvious without explicitly asking the contributors to check them?

Plus, we don't have a code style defined for this project yet.

Description

The first step in terms of dev/coding for this project is, I think, the signup/login view.

Signing up will be useful in case people want to associate their submission with their email address. In my opinion, it's important for people to have that option so that if the submission is not complete, we can go back and forth to make sure it's in a good enough state for us to feature on the website.

Quoting myself from #10:

The first step is the signup flow as I mentioned at #14, and then after that, maybe a submission box? We can store them privately for now (probably in Supabase or Firebase), and once we have a few, we can make a view for showing those questions.

This should be possible to implement as we have #33 and #34 implemented already.

Description

Let's add missing docs.

https://github.com/ykdojo/defaang/community

Description

The root directory has many dotfiles and config files, and it's not a very pleasant experience.

We should clean up some of them so it's easier to get started contributing to this repo.

Description

We can probably just use simple dark.

Create a header bar with a login/signup link.

If the user is already logged in, we should show the user's info - (part of) the email address for now.

Description

The features issue template is no longer working, maybe after #46.

Screenshots

Description

Can I start working on the authentication part of the sign-in and sign-up page and what are the platforms we will allow the user to authenticate themselves?

Description

From Contributing.md:

There are three categories of issues on the defaang GitHub issue tracker:

1. Bugs come in two flavours: non-critical and critical. Non-critical bugs are those that sometimes can mean a nuisance but that do not seriously affect working with the app. Critical bugs, however, make the app barely or un-usable, and fixes need to be addressed urgently.
2. Enhancements are some small additions that require adding some more functionality to a feature, but that should not evolve into an own distinct feature. Even if the issue description reads like a full feature to you, the "enhancement" label means there is already said functionality, which just needs to be amended. Please ask if you are unsure.
3. Features are bigger additions to the application that require a completely new feature.

I don't think we use these labels yet - so we should probably remove this section until/unless we do.

Description

Update the landing page/home page to look better and change the title from "Defaang" to "defaang"

Who can submit the question?
How to check the credibility of the submitter?
are there is any system to validate the questions?

Description

I think we lost a link to the project board - so we should add it back.

Also, we should link to the discussions page when we mention discussions, and the issues page when we mention issues.