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

Frontend redesign #1899

Closed
8 tasks
mbrandau opened this issue Aug 11, 2018 · 16 comments
Closed
8 tasks

Frontend redesign #1899

mbrandau opened this issue Aug 11, 2018 · 16 comments
Labels
frontend The Docusaurus app serving the docs site

Comments

@mbrandau
Copy link
Contributor

mbrandau commented Aug 11, 2018

As mentioned in #1070, this will cover a complete redesign of the frontend.
The current frontend is rather useful than good looking. The goal is to make it both easy to use and giving it a modern look on both desktop and mobile devices.

TODOs:

  • Designs
    • style form elements (input, select, button)
    • create visual designs for mobile and desktop viewports
  • Adopt styled-components
    • Container
    • form elements
  • UX errors
    • categories links aren't displayed on example pages
    • emphasize search box
    • "donate" link is nearly invisible
    • consistent naming of the left side of the badge (label -> subject)

I also thought about adding an about section to the index page with some information about the project.

@PyvesB PyvesB added the frontend The Docusaurus app serving the docs site label Aug 11, 2018
@mbrandau
Copy link
Contributor Author

This would be a perfect opportunity to address #843 too!

@paulmelnikow
Copy link
Member

This sounds great! Thanks for picking this up!

On the technical side, something I've been thinking about is adopting styled-components which means we wouldn't need to ship any CSS files. It works by creating classes so it's performant, and plays really nicely with React.

I have a bit of design input. We could set up a phone call or I could try to put it into writing. What would be best, do you think?

cc @rozaxe

@chris48s
Copy link
Member

Big 👍 on this and thanks for picking it up again. As I've noted elsewhere, I'd love to see us adopt a more mobile-friendly style.

TODO list looks great but I think the best way to work on this would be to split this into more than 1 PR and work on a subset of functionality as a first step. I'd prioritise the the layout changes, but leave out stuff like an 'about' section, #843, maybe even initially the menu. That will make it easier to review and make progress.

@mbrandau
Copy link
Contributor Author

@paulmelnikow I think it would be better if we maintain a list of design ideas in this issue. I don't know too much about styled-components, but I'm ready to take a quick dive into that topic.

@chris48s I would definitely not do it in just one PR. I agree with you on leaving out the 'about' section, but the missing menu is a real UX problem. #843 doesn't seem too hard to implement, especially with React, so I would like to give this a shot too.

@chris48s
Copy link
Member

I'll leave it with you to divide into sensible chunks :)

@rozaxe
Copy link

rozaxe commented Aug 12, 2018

I would be happy to help you integrate the tool from #843 into the new interface if I can get some guidance about React because I never used it.

@paulmelnikow
Copy link
Member

Cool, I'll work on writing up my thoughts on the UX.

@mbrandau It sounds like you're down to work on both design and implementation, which is great! Would you like to work with @rozaxe on #843? I'd suggest starting the implementation work by breaking out the "Your Badge" section – with the static + dynamic badge builders – onto their own page. Does that jive with your thoughts about the design?

@mbrandau
Copy link
Contributor Author

@paulmelnikow Splitting the page up sounds good! I'm gonna get the basics set up so @rozaxe can work with it.

@mbrandau
Copy link
Contributor Author

@paulmelnikow I started using styled-components at https://github.com/mbrandau/shields/blob/master/frontend/components/static-badge-maker.js for my work on #843. Is that the way you want to go?

@PyvesB
Copy link
Member

PyvesB commented Aug 25, 2018

I'm not familiar with styled-components, but it does seem like a good idea. 😉

@paulmelnikow
Copy link
Member

I haven’t forgotten about this! I made some notes about the UX but haven’t had time to write them up yet. I’ll be offline for a few days but I’ll pick this up when I’m back online.

@paulmelnikow
Copy link
Member

I've got some functionality-focused work going on in #2496.

Are you guys interested in picking this back up? I'll take the time to write up my notes. Perhaps we could also schedule a call. Bandwidth is higher that way. We could also decide on a good design process :)

@mbrandau
Copy link
Contributor Author

mbrandau commented Jan 4, 2019

I'm definitely interested. I just need to get back into the code and check out what changed.
I'm also gonna write down some ideas for the design. I'll let you know when I'm ready :)

@mathcodes
Copy link

I'm interested in tackling this with or without others to help. Let me know! Ready when you are, though I can probably only commit to 2-3 of hours a week, but it will be steady!

@chris48s
Copy link
Member

@mathcodes - we are tantalisingly close to deploying a new frontend (PR: #9014 )
Watch this space..

@chris48s
Copy link
Member

We have just launched a completely redesigned frontend https://shields.io/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend The Docusaurus app serving the docs site
Projects
None yet
Development

No branches or pull requests

6 participants