Code Monkey home page Code Monkey logo

glamorous-website's Introduction

glamorous
glamorous-website πŸ’„

This is the website for glamorous and is built with next and glamorous of course.

Build Status Code Coverage All Contributors PRs Welcome Code of Conduct Watch on GitHub Star on GitHub Tweet

Contributing

See CONTRIBUTING.md.

Contributors

Thanks goes to these people (emoji key):


Kent C. Dodds

πŸ’» πŸ“– πŸš‡ ⚠️ πŸ‘€

Paul Molluzzo

πŸ’» πŸ“– πŸ‘€ ⚠️

zhu haihao

πŸ’» πŸ“– 🌍

Montlouis-Calixte StΓ©phane

πŸ’» πŸ‘€

Parvez Kose

πŸ“–

William I. Olojede

πŸ“–

Michael Altamirano

πŸ’» πŸ“–

Bhargav Anand

πŸ’» πŸ“–

George "Tre" Ammatuna

πŸ“–

Wojciech Kwolek

πŸ’»

Arana Jhonny

🌍

Anthony Ascencio

πŸ“– 🌍

tdeschryver

πŸ’» πŸ‘€

Mike Wickett

πŸ’» 🎨

Dan Seethaler

πŸ’‘

Yuan Chuan

πŸ‘€

Phil PlΓΌckthun

πŸ‘€

Hsin-chieh Yeh

πŸ‘€

Bernard Lin

πŸ‘€

Maxime Laforet

πŸ‘€

Etienne Talbot

πŸ‘€

Karl Groves

πŸ‘€

Antonio Laguna

πŸ‘€

Simon Lydell

πŸ‘€

Anujan Panchadcharam

πŸ‘€

Carl Rosell

πŸ’»

Aaron Olson

πŸ“–

Christian Gill

πŸ’»

Jon Major

🎨

Hozefa

πŸ’» πŸ‘€

Audora Chalker

πŸ“–

Josh Robertson

πŸ“–

Alessandro Arnodo

πŸ‘€

Aviv Rosental

πŸ‘€

Atticus White

πŸ‘€

Nitin Tulswani

πŸ’‘

Jesse

🎨 🌍 πŸ’» πŸ“– πŸ‘€

Marc Apfelbaum

🌍 πŸ‘€

Kai Richard KΓΆnig

πŸ‘€

Moe Sattler

πŸ‘€ 🌍

Ian De La Cruz

πŸ’»

Atsushi Yamamoto


Jeppe Reinhold

πŸ“–

Igor Konovalov

🌍 πŸ‘€

Luzanov Pavel

πŸ‘€ 🌍

Gleb Kost

πŸ“– 🌍

Kristian

πŸ’‘

Cole Bemis

πŸ’‘

BjΓΆrn Ricks

πŸ’» πŸ“–

marzelin

πŸ“–

Peter Schussheim

πŸ’‘ πŸ”Œ

Ken Powers

πŸ’‘

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT

glamorous-website's People

Contributors

aarondolson avatar akikoskinen avatar anenth avatar aranajhonny avatar audoralc avatar bernard-lin avatar bjoernricks avatar carlrosell avatar danreeves avatar forresst avatar gillchristian avatar haroenv avatar igitscor avatar igorkonovalov avatar imbhargav5 avatar irth avatar jumbosushi avatar kristian-puccio avatar liadbiz avatar luke-john avatar michaeljaltamirano avatar motleydev avatar mwickett avatar paulmolluzzo avatar smontlouis avatar timdeschryver avatar tretuna avatar whoisandy avatar williamolojede avatar zabute avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

glamorous-website's Issues

auto-prettier-eslint markdown strings

There's kind of a tool for this, but I don't think it'll work with the way we're doing things. But it'd be pretty sweet to have a tool that'd automatically apply prettier-eslint to all of our code examples in our markdown strings :)

integrations -> recompose

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Fixup tests

Right now, pretty much any change is going to result in snapshots breaking. That's fine, but one thing I want to avoid is having to update the snapshots for every content change. We want this to be really easy for folks to contribute to and that means being able to contribute without even pulling down the repo and just using the GitHub editor for updating content.

I'm unsure of the best way to solve this. I just don't want to have to update snapshots every single time there's a content change.

advanced -> theming

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Remove coloring of visited links

Because on sites like this one, normally folks don't care whether they've been there before and it's distracting IMO.

Also this is ugly πŸ˜›:

screen shot 2017-06-05 at 8 55 02 pm

integrations -> jest

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

integrations -> next

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

basics -> dynamic styles

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Check accessibility

In particular, we should verify color contrast and font sizes are accessible πŸ‘ we already have eslint-plugin-jsx-a11y which is really helpful for many things. Would be great to just make sure our design is accessible to people πŸ‘

Add Documentation

There is a URL /docs that we'd like to populate with documentation. The documentation that we have now is all piled into the README of glamorous.

Ideally the documentation we store will be in markdown to make it easy or other people to contribute.

Since there is no content just yet, there's a lot of flexibility on how to structure this. It might be worth creating a directory like docs and then putting the markdown files in there. Then we can load the markdown files into the /docs page.

An idea I have is to split the documentation up into separate files like according to the headers. From there we might have an easier time supporting searching and direct linking to topics through query params.

api -> glamorous

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Add in License, Contributing, Code of Conduct, etc

We'd like to have this as a MIT licensed project, but there isn't any LICENSE file yet.

In addition, we should probably add a Contributing file and Code of Conduct.

Any other neat things we can think of (PR templates, commitzen, etc.) could be helpful too. Whatever makes it easy for people to contribute! πŸ˜„

Code Site Designs

creating wireframes with sketch so that the look n feel of the website is agreed upon.

advanced -> size

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Complete Site Design; Use Theme Provider

The site's design could use lots of attention, and while it's being done we may want to move global style choices (colors, typography, etc) into a ThemeProvider and then use the ThemeProvider in the layout component.

Further, there is a mix of uses of glamorous in this site. There are inline component definitions and glamorousComponentFactory definitions, which makes it a little harder to find your way around the codebase. We may want to lean towards one method for the sake of coherence and legibility, and in consideration of the use of a ThemeProvider it might be clearer to use glamorousComponentFactory.

Consider this example, where we can use the theme in a component to define a common color and media query.

const StyledHeading = glamorous.H1((props, theme) => ({
  color: theme.colors.primary, // uses theme as single location for definitions
  fontSize: 10,

   // pulls in the query definition from theme
   [theme.mediaQueries.mobile]: {
      fontSize: 20
  }
}))

export default () => <StyledHeading>glamorous</StyledHeading>

integrations -> polished

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Add analytics

Analytics will help give us an idea of what people are looking at most and where to focus efforts.

I don't think Google analytics in the browser will be good enough because many of our target audience blocks those. Any ideas?

Make a way to have a special callout in markdown

When I used README.io for angular-formly I really liked the "callout" feature:

screen shot 2017-06-09 at 10 04 55 pm

screen shot 2017-06-09 at 10 04 23 pm

screen shot 2017-06-09 at 10 04 18 pm

screen shot 2017-06-09 at 10 04 09 pm

I think that we could add another pragmaHandler here to support a syntax like this:

# this is some markdown

```callout {type: 'info', title: 'Alternative method'}
You could also do things like such-and such... blah blah

And `markdown` should work *here* too
```

I'm thinking about doing this myself, but we probably need a design for this...

advanced -> existing CSS

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

[meta] Add labels to GH repo

I think it'd be great to have some more labels available on this repo so we can organize tasks and make it easier for people to find something they can contribute that falls within their skill set. Off the top of my head I'm thinking:

  • Good for Beginner (or "Good First PR", something to highlight tasks that don't require a ton of background knowledge)
  • Documentation
  • Has PR
  • Under Discussion

Anything else?

basics -> getting started

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Fix build for PRs coming from forks

Because this.

We just need to check in our scripts whether the PR is coming from a fork and if it is, we just don't attempt to deploy. Could probably do this at the top of other/now-travis...

integrations -> create-react-app

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

basics -> React Native

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

autoscale main deployment

Right now the production deployment will freeze after an hour of inactivity. That's kinda annoying. So I have to do now scale https://rc.glamorous.rocks every time there's a new deploy if I don't want it to freeze. By the time the website is live, I don't want to have to do that with https://glamorous.rocks. Let's automate that (just for the production deployment).

Add search functionality

I don't know how other folks do this, but I think that Algolia is what several others use. Anyone wanna know what it'd take to do that?

basics -> animation

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Twitter card

Before we officially announce the website, we should probably have a slick looking twitter preview card for it so when folks tweet about it, they see something awesome (in addition to the equally awesome domain: https://glamorous.rocks/)

So I'd love to get some mocks together for a good twitter card. We could do small:

screen shot 2017-05-30 at 11 59 45 am

Or large:

screen shot 2017-05-30 at 12 00 18 pm

Once we have the image we want to use, we'll need to implement the twitter/facebook meta tags. I did this with JavaScript Air and this is what it looked like:

<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="google-site-verification" content="85n8ZBk_3hSeShlRmsVJXgDolakFG4UsMJgpy3mQyPs" />
<meta name="theme-color" content="#efdd4f" />
<meta name="author" content="JavaScript Air" />
<link rel="publisher" href="https://plus.google.com/b/105493143005968326308" />
<meta name="description" content="Episode 049 of the live JavaScript broadcast podcast. Kent C. Dodds has sunset JavaScript Air. No shows are currently scheduled." />
<meta name="description" content="Episode 049 of the live JavaScript broadcast podcast. Kent C. Dodds has sunset JavaScript Air. No shows are currently scheduled." />
<meta name="keywords" content="Maybe one day..." />
<meta name="author" content="JavaScript Air" />
<meta name="copyright" content="2016" />
<meta name="application-name" content="JavaScript Air Podcast" />
<meta property="og:title" content="Maybe one day..." />
<meta property="og:type" content="video" />
<meta property="og:image" content="https://javascriptair.com/episodes/2222-10-18/screenshot.png" />
<meta property="og:url" content="https://javascriptair.com/episodes/2222-10-18" />
<meta property="og:description" content="Episode 049 of the live JavaScript broadcast podcast. Kent C. Dodds has sunset JavaScript Air. No shows are currently scheduled." />
<meta property="og:site_name" content="JavaScript Air" />
<meta property="video:release_date" content="2222-10-18" />
<meta property="og:video:url" content="https://www.youtube.com/embed/" />
<meta property="og:video:secure_url" content="https://www.youtube.com/embed/" />
<meta property="og:video:type" content="text/html" />
<meta property="og:video:width" content="1280" />
<meta property="og:video:height" content="720" />
<meta property="og:video:url" content="https://www.youtube.com/v/?version=3&amp;amp;autohide=1" />
<meta property="og:video:secure_url" content="https://www.youtube.com/v/?version=3&amp;amp;autohide=1" />
<meta property="og:video:type" content="application/x-shockwave-flash" />
<meta property="og:video:width" content="1280" />
<meta property="og:video:height" content="720" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Maybe one day..." />
<meta name="twitter:description" content="Episode 049 of the live JavaScript broadcast podcast. Kent C. Dodds has sunset JavaScript Air. No shows are currently scheduled." />
<meta name="twitter:image" content="https://javascriptair.com/episodes/2222-10-18/screenshot.png" />
<meta name="twitter:image:alt" content="JavaScript Air episode card with information about the guests, the episode description, and the episode date and time" />
<meta name="twitter:site" content="@JavaScriptAir" />
<meta name="twitter:creator" content="@JavaScriptAir" />
<meta name="twitter:player" content="https://www.youtube.com/embed/" />
<meta name="twitter:player:width" content="1280" />
<meta name="twitter:player:height" content="720" />
<link rel="shortcut icon" type="image/png" href="/favicon.ico" />
<link rel="manifest" href="/resources/manifest/manifest.json" />

Some of those things are not relevant, but much of it would be :)

basics -> core concepts

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

api -> glamorousComponentFactory

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

advanced -> Server Side Rendering (SSR)

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Add in Internationalization and language support

In the original CodeSandbox there was support for several languages, but in the initial port to next it was not preserved.

We'd like internationalization that supports language selection and will modify all of the UI content (nav, footer, buttons) and when #5 is complete, should also be used to load the correct translation of the documentation.

The CodeSandbox used react-intl so whoever takes this on may want to investigate that library and use it.

Fix localization.

Sadly, it turns out that using *.js files for localization does not work very well for any localization tool :-(

So I'm thinking that maybe we should have a build step. We could actually have a separate build for every locale as well which may not be a terrible idea. Doing this would allow us to do the static export when it's officially released in next.js.

I'm going to start to work on something, but I'm very open to any ideas folks have!

integrations -> glamor

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Add flow

That would really help I think.

Add Roadmap.md

Roadmap link in CONTRIBUTING.md is pointing to 404 page. Please create the Roadmap page.

basics -> installation

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

api -> TypeScript

Learn how to set up the project here and how docs work here. For much of this you should be able to do everything without even cloning the project. You could just do it in the GitHub editor!

Anyone can work on this Just comment here when you're going to start. Feel free to improve the existing docs if you're copying them over (it doesn't have to be a direct copy/paste if feel you can improve upon them).

Thanks!

Change the favicon

Problem description:
The current favicon is too tiny to make sense out of - Neither the lipstick nor the name is visible. I feel it is because of the too too much surrounding white space.

Suggested solution:
Can we use one of the other logos that we have - The lipstick with g on the side or the background, etc? Or just the lipstick with the braces?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.