daily.dev App Suite

Everything you see on daily.dev 👀

This monorepo contains daily.dev's application suite. The repo includes the web app and the extension, along with shared components for the two. By using a monorepo approach, we can easily share code and maintain consistency across the different parts of the application suite. The decision was made to allow faster iterations and to keep features parity in both platforms.

Technologies

• Node v20.12.0 (a .nvmrc is presented for nvm users).
• pnpm for managing the monorepo and dependencies.

Projects

packages

contains a collection of smaller projects or libraries that are used across the daily.dev application suite. Here's a brief overview of each package mentioned:

• eslint-config

  Shared ESLint settings for maintaining consistent code quality across the project.

• eslint-rules

  A custom ESLint plugin that defines a set of rules for the project, including a rule to enforce consistent color usage.

• extension

  The browser extension project. Includes webpack configuration for browser extensions and the dedicated components just for the extension.

• prettier-config

  Shared Prettier settings for all the projects in this repo.

• shared

  The main project contains most of the components used in the applications. Every component that needs to be used on both platforms should be placed in this project. This includes the design system components, custom hooks, and many more.

• storybook

  The Storybook configuration for the project, used to develop and showcase UI components in isolation.

• webapp

  The web app project. This is a Next.js project and has more pages than the extension, such as a registration page, post page, profile page, etc. For more information click here.

Local Environment

To spin up a local environment, we suggest using GitPod. We have a GitPod button above, everything is already configured and should work out of the box. Click on it and let's roll!

Note: Checkout getting started with GitPod using their official docs. If you're new to gitPod, don't worry, it's a simple and powerful tool that will help you get started with this project in no time.

Want to Help?

So you want to contribute to daily.dev app suite and make an impact, we are glad to hear it. 😍

Before you proceed we have a few guidelines for contribution that will make everything much easier.

We would appreciate if you dedicate the time and read them carefully: https://github.com/dailydotdev/.github/blob/master/CONTRIBUTING.md

Bootstrap Project

After cloning the project, please make sure to run the following commands to bootstrap the project:

npm i -g [email protected]
pnpm install

Run Extension Locally

Example for Chrome:

• Run pnpm --filter extension dev:chrome in the root directory
• Open Chrome and go to chrome://extensions/
• Enable Developer mode in the top right corner
• Click on Load unpacked and select the packages/extension/dist/chrome folder
• The extension should be loaded and you should be able to see it in the extensions list
• Enable the extension, don't forget to disable it when you are done
• Disable the production extension if you have it installed as it might cause conflicts