aptotude / circle-build-health Goto Github PK

View Code? Open in Web Editor NEW

5.0 5.0 3.0 365 KB

A build light view for your circle ci projects.

CSS 23.33% JavaScript 75.87% Dockerfile 0.81%

circle-build-health's Introduction

#Aptotude A React UI library for Apto

Quick links

Documentation

Getting started

Step 1: Install Aptotude

NPM

npm install --save @apto/aptotude

Yarn

yarn add @apto/aptotude

Creating a Component

Add a new directory in the components directory. Start the name with a capital letter.
The component file should be named 'AptoYourComponent.tsx'.
When you export your component do not use default just export the class

export class AptoFoo extends React.Component {}

Tests for your component should be a subdirectory named __tests__ in your component directory.
Stories should be in your component directory and named AptoYourComponent.stories.tsx.
Create an index.ts file in your component's directory and export your compnent from it.

export * from AptoFoo;

In the component/index.ts file export your component

... other exports
export * from AptoFoo

circle-build-health's People

Contributors

Stargazers

Watchers

Forkers

lathonez wbeard

circle-build-health's Issues

Optimize bundle size of servers that do not need optional modules

I'd like to optimize builds of server.js to not include modules that were not needed (e.g. passport, connect-redis) at build time, as expressed by environment variables.

At the time of writing, the final server.js build is 72kb.

I'm open to ideas on how to go about doing this. I have ideas but am trying to open it up to Hacktoberfest participants.

Document how to set up Auth0 to be a free auth provider

I'd like to see some documentation for how to configure an Auth0 app and how to use the environment variables needed to put this behind an auth screen.

Bonus points if the tutorial teaches you how to configure an auth screen that allows logins only from a certain domain (e.g. your company's domain).

Must define RAZZLE_AUTH0_* or Error is thrown

After running yarn start without defining any AUTH0 variables in .env:

Error: You must provide the domain configuration value to use passport-auth0.
    at /Users/jasonb/Self/projects/circle-build-health/node_modules/passport-auth0/lib/index.js:36:13
    at Array.forEach (<anonymous>)
    at new Strategy (/Users/jasonb/Self/projects/circle-build-health/node_modules/passport-auth0/lib/index.js:34:20)
    at Object../src/serverAuth.js (/Users/jasonb/Self/projects/circle-build-health/build/server.js:2289:16)    at __webpack_require__ (/Users/jasonb/Self/projects/circle-build-health/build/server.js:630:30)
    at fn (/Users/jasonb/Self/projects/circle-build-health/build/server.js:48:20)
    at Object../src/server.js (/Users/jasonb/Self/projects/circle-build-health/build/server.js:2017:71)
    at __webpack_require__ (/Users/jasonb/Self/projects/circle-build-health/build/server.js:630:30)
    at fn (/Users/jasonb/Self/projects/circle-build-health/build/server.js:48:20)
    at Object../src/index.js (/Users/jasonb/Self/projects/circle-build-health/build/server.js:1941:66)

I thought setting RAZZLE_USE_AUTH0=false would negate the need to define the other variables.

Upgrade razzle to 2.0

It would be great to get razzle updated to 2. Not sure if there are any breaking changes.

I don't have any tests, working on that.

Create a Docker image

In an effort to diversify the number of environments in which this can run, I'd like to add a Dockerfile that allows this app to run in a docker container.

Create a "Deploy to Heroku" Button

In an effort to diversify the number of environments in which this can run, I'd like to add a "Deploy to Heroku" button in the README.

Here's an article, from heroku, on how to do this - https://devcenter.heroku.com/articles/heroku-button.

Thanks!

Update NodeJS Dependencies for NodeJS 10

When running on NodeJS > 9, you get the following error:

error [email protected]: The engine "node" is incompatible with this module. Expected version ">=4 <=9". Got "10.12.0"

This is probably easy to fix bu upgrading a few dependencies to a more recent version...

Use Redis as a session store

I'd like to start using something like https://github.com/tj/connect-redis to persist sessions as the current in-memory strategy is not going to be scalable.

The trick though is, in order to keep things flexible, I'd like to flag the usage of redis as a session store via environment variables. I would like to keep the environment variables used for infrastructure following a pattern that emphasizes configuration over code.