Skip to content

Latest commit

 

History

History
66 lines (34 loc) · 3.04 KB

README.md

File metadata and controls

66 lines (34 loc) · 3.04 KB

sleeper

Sleeper

An ambient new tab browser extension

Installation

Sleeper is available for Chrome, Firefox and Edge. See it in action at sleeper.fyi.

Architecture

This is a monorepo using yarn workspaces that contains the sleeper extension and website.

The extension and site are built with React using create-react-app, blobs, framer-motion, and styled-components. Design based on iOS 13 dark mode wallpapers.

The extension contains scripts to bundle and zip the project for release. The website is hosted by Netlify which watches the master branch of this repo and automatically deploys the site on change.

The project is versioned with npm-version, which triggers the extension build script then pushes the repo which redeploys the site.

Netlify Status

Available Scripts

In the root project directory, you can run:

yarn install

Installs the node_modules required to run and build the apps.

yarn start

Runs the extension and website in the development mode.

Open http://localhost:3000 and http://localhost:4000 to view them in the browser.

Projects can be run individually with yarn ext or yarn web.

The page will reload if you make edits.

You will also see any lint errors in the console.

yarn build

Builds the extension and website for production to their respective build folders.

Projects can be built individually with yarn ext:build or yarn web:build.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

yarn ext:release

Builds and zips the app for production as sleeper-vX.X.X.zip in the extension directory.

When a release is ready, run npm version with major/minor/patch and message.

Additional Info

See the extension and website projects for more info.

This is a goldilocks.design project by @scotato 🤞