46brew ·

A simple app to help you brew the perfect cup ☕️

Inspired by the 4:6 brewing method I wanted to create a simple tool that would help me along the way, giving me the stats I need while I brew my coffee ☕️ 👷‍♂️

Installing / Getting started

yarn install
yarn start

This runs the server in production.

Developing

Built With

This project uses Next.js which makes it easy to create React apps with zero config. Styling is done with Tachyons, and custom stuff is achieved with Next's built in Styled JSX. Check out the NextJS blog for a good primer.

Prerequisites

A fresh Node version (I think 11 is the minimum requirement).

Setting up Dev

To start developing, first clone the repo

git clone https://github.com/rix1/46brew.git 46brew
cd 46brew/
yarn install

That's it! To fire up a local dev server, do:

yarn dev

See additional scripts in package.json.

Building

To build a production ready application, do:

yarn build

Nextjs is set up with Webpack(?) and Babel, and takes care of bundeling everyhing for us.

Deploying / Publishing

The 46brew.app site is kept up to date with the master branch due to Vercel's Github integration. This integration also deploy previews of all branches.

I found it useful to do semantic versioning and tag major releases to make improve the analytics experience.

To do this, I've set up np to create new releases. However, as this app isn't available on NPM, we've configured it to skip the actual publishing. This way, the tool only helps me bump version numbers, tag stuff correctly and use Github's releases page with specific notes.

Tests

I'm thinking about using Jest, but I guess I'll with installing this until I need it.

Style guide

Using Prettier for formatting, Eslint for linting and Flowtype for static type checking.

Licensing

MIT

rix1 / 46brew