Skip to content

docs(README.md): minor grammar updates #1803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rebelchris merged 4 commits into from
Jun 30, 2023
Merged

docs(README.md): minor grammar updates #1803

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
315ac6f
docs(README.md): minor grammar updates
jofftiquez May 13, 2023
36d5fc1
Merge branch 'main' into patch-1
jofftiquez May 14, 2023
32d94d7
Merge branch 'main' into patch-1
jofftiquez Jun 15, 2023
bc9207f
Merge branch 'main' into patch-1
rebelchris Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,23 @@ The decision was made to allow faster iterations and to keep features parity in

### eslint-config

Shared settings for eslint for all the projects in this repo.
Shared ESLint settings for all the projects in this repo.

### extension

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

### prettier-config

Shared settings for prettier for all the projects in this repo.
Shared Prettier settings for all the projects in this repo.

### shared

The main project with most of the components that are used in the applications. Every component that need to be used in both platforms should be placed in this project. This includes the design system components, custom hooks, and many more.
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.

### webapp

The web app project. It is a Next.js project and it has more pages than the extension. Such as registration page, post page, profile page, etc.
For more information [click here](https://github.com/dailydotdev/apps/tree/master/packages/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](https://github.com/dailydotdev/apps/tree/master/packages/webapp).

## Local Environment

Expand All @@ -62,13 +61,15 @@ We have a GitPod button above, click on it and let's roll!
So you want to contribute to daily.dev app suite and make an impact, we are glad to hear it. :heart_eyes:

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:
```

```bash
npm i -g pnpm
pnpm install
```
Expand Down