dailybruin / lux Goto Github PK

View Code? Open in Web Editor NEW

6.0 10.0 5.0 44.23 MB

Lux is a design system for the Daily Bruin.

Home Page: https://lux.dailybruin.com

License: GNU General Public License v3.0

TypeScript 79.13% JavaScript 1.02% MDX 19.85%

design-system

lux's Introduction

Lux

Lux is a design system for the Daily Bruin, written in TypeScript and React.

You may also be interested in projects that use Lux, which include our gatsby starter and dailybruin.com's frontend.

Usage

To use Lux, simply install it with your favorite package manager, e.g.:

yarn add @dailybruin/lux

Import components with the following syntax:

import { Article } from '@dailybruin/lux'

Note that Lux is published as TypeScript files, and thus is only available to projects that use TypeScript and some kind of build system (e.g., Webpack). If you run into errors setting Lux up with your project, please file an issue.

Development

To start a dev server for the docs:

yarn start

To test:

yarn test

Deployment

Lux is autopublished to npm by Travis with semantic-release and travis build stages. Tokens were set up with semantic-release-cli (semantic-release-cli setup), using dailybruin-bot's npm and GitHub credentials.

yarn publish

To build the docs:

yarn build:docs

lux's People

Contributors

Stargazers

Watchers

Forkers

legitmaxwu ahujaradhika bahaagit neenahkarima jadajc47

lux's Issues

refactor main site link

planned: mainsitearticleheader uses a ton of links with

text-decoration: none;
                color: ${dailyBruinBlue};

                :hover {
                  opacity: 0.75;
 }

We can refactor this into a MainSiteLink component - because link behavior and appearance in body text should be consistent across the entire site to promote good UX

Importing lux - webfont error

Trying to use Lux footer inside the main site app but running into an issue where webfontloader leads to a compilation issue.

Add custom css props to all lux components

We should be able to add custom css to lux components. This should be done through an additional style prop that takes a string.

An example to look would look like this:

<Image
  url="http://dailybruin.com/images/2018/10/web.sp_.mwp_.nbk_.ADX_-640x461.jpg"
  caption="Freshman attacker Ashworth Molthen has registered 21 goals on the season, finding the back of the net in 13 of the 16 games so far this year for UCLA men’s water polo. UCLA is one of two teams remaining in the MPSF conference that remains undefeated."
  credit="Amy Dixon/Photo editor"
  alt="Ashworth Molthen playing water polo."
  style={css`
    color: red;
  `}
/>

You'll want to check out the emotion docs on composition.

Create review/sports info box component

ARTS BOX - example at https://dailybruin.com/2018/10/05/album-review-twenty-one-pilots-trench-falls-flat-fails-to-produce-a-variety-of-sounds/
Needs

Review title (required)
Custom Line 1 (optional)
Custom Line 2 (optional)
Date (required)
Rating (out of 5) (required)

SPORTS BOX - example at http://dailybruin.com/2018/11/05/womens-volleyball-defeats-oregon-state-falls-to-oregon/

Sport name (required)
Team 1 (required)
Team 2 (required)
Team 1 score (required)
Team 2 score (required)

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource	Name	Replacement PR?
npm	`react-testing-library`
npm	`travis-deploy-once`
npm	`tslint`
npm	`tslint-react`

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

fix(deps): update dependency react-emotion to v10
fix(deps): update emotion monorepo to v11 (major) (emotion, emotion-server, jest-emotion)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update dependency gatsby to v4 [security]
fix(deps): update all non-major dependencies (@fortawesome/fontawesome-svg-core, @fortawesome/free-solid-svg-icons, @fortawesome/react-fontawesome, @mdx-js/react, @types/jest, @types/react, @types/react-dom, @types/react-helmet, @types/webfontloader, commitizen, d3, docz, lint-staged, plyr, react, react-dom, react-player, react-string-replace, react-testing-library, semantic-release, slugify, tslint, tslint-config-prettier, typescript, webpack)
chore(deps): update dependency @mdx-js/react to v3
chore(deps): update dependency commitizen to v4
chore(deps): update dependency cz-conventional-changelog to v3
chore(deps): update dependency react-testing-library to v8
chore(deps): update jest monorepo to v29 (major) (@types/jest, jest, ts-jest)
fix(deps): update dependency gatsby-plugin-emotion to v8
Click on this checkbox to rebase all open PRs at once

Detected dependencies

npm

package.json

@fortawesome/fontawesome-svg-core ^1.2.8

@fortawesome/free-solid-svg-icons ^5.5.0

@fortawesome/react-fontawesome ^0.1.3

@hbetts/parse-repository-url 2.1.2

d3 ^5.9.1

emotion ^9.2.12

emotion-server ^9.2.12

gatsby-plugin-emotion ^2.0.6

lodash.uniq ^4.5.0

plyr ^3.4.7

react 16.8.6

react-dom 16.8.6

react-emotion ^9.2.12

react-helmet ^5.2.0

react-player 2.14.1

react-plyr ^2.1.1

react-string-replace 0.4.4

slugify ^1.3.3

typescript 3.4.4

webfontloader ^1.6.28

@mdx-js/react 1.0.20

@types/jest 23.3.12

@types/react 16.7.18

@types/react-dom 16.0.11

@types/react-helmet 5.0.8

@types/webfontloader 1.6.29

commitizen 3.0.5

cz-conventional-changelog 2.1.0

docz 1.2.0

docz-plugin-css 0.11.0

docz-plugin-netlify 1.1.4

docz-theme-default 1.2.0

eclint 2.8.1

gatsby 2.0.89

husky 1.3.1

jest 23.6.0

jest-emotion 9.2.11

lint-staged 8.1.0

react-testing-library 5.4.4

semantic-release 15.13.2

travis-deploy-once 5.0.11

ts-jest 23.10.5

tslint 5.16.0

tslint-config-prettier 1.17.0

tslint-eslint-rules 5.4.0

tslint-react 3.6.0

webpack ^4.28.4

travis

.travis.yml

Check this box to trigger a request for Renovate to run again on this repository

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Create photo gallery

Dependency deprecation warning: travis-deploy-once (npm)

On registry https://registry.npmjs.org/, the "latest" version (v5.0.11) of dependency travis-deploy-once has the following deprecation notice:

We recommend to use Travis Build Stages instead

Marking the latest version of an npm package as deprecated results in the entire package being considered deprecated, so contact the package author you think this is a mistake.

Affected package file(s): package.json

If you don't care about this, you can close this issue and not be warned about travis-deploy-once's deprecation again. If you would like to completely disable all future deprecation warnings then add the following to your config:

"suppressNotifications": ["deprecationWarningIssues"]

Update article card with main site styling

Article cards come in these three variants. They should have a section category, headline, byline, photo and blurb

Insert check for all DOM globals (document, window, etc.)

Description

When using Lux with Gatsby to compile to HTML, it fails on the use of document and window since these are not present on SSR (server-side rendering)

Use context API instead of props for main site components

Disable import ordering in tslint

Don't know how much value this adds to a project

Create poll component

test issue

test issue from slack!

Create file for global CSS breakpoints

So we can centralize these and not have to rewrite them every time

Create Author card

Create popular stories/editors' picks component

Editors picks + popular stories are essentially the same thing

we can return 3 links for each card
each link should have a title and a blurb
editors picks additionally has a photo at the top related to the first link

UP small font size for main site

lux/src/globals/mainsiteGlobalStyles.tsx

Line 37 in 8a1b66e

export const smallInfoFontSize = '0.8em'

It's a tad too small right now - 0.9em would probably work best

Navbar

Add a navbar which will stick to the top of the page and will hold links that jump to other pages (Gatsby Link) on the site or id's on the same page (and potentially external links?)
Have a style prop to allow for custom css, keep the css minimal as a base.

An idea for the links prop is an array of objects with the structure:

{
    title: string, // what shows up in the nav bar
    targeturl: string, // where the link points to
    type: string // declaring the link as external, internal, or id, could make this an enum
}

You could forgo the type key and have the navbar figure out internally what type of link it is (# at the front for ids, http at the front for external links) but I think declaring it is the better way to go.

This is just a suggestion, comment for a better solution and we can work it out.