Skip to content
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.

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

Docs/update readme #3783

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

Anadudev
Copy link

Changes

This PR aims to make it easier for new contributors to get started with the project by:

  1. Linking relevant files:

    • Added direct links to files mentioned in the README for quick reference.
  2. Simplifying local setup:

    • Provided more detailed and beginner-friendly instructions for setting up the project locally.

    • Clarified the steps involved in installing dependencies and running the project.

  3. Updating the package list:

    • Added missing packages to the list of dependencies.
      By making these improvements, we hope to lower the barrier of entry for new contributors and encourage more people to participate in the project.

Please review the following:

  • The clarity and conciseness of the new instructions.
  • The accuracy of the updated package list.
  • The overall readability and formatting of the README.
    Thank you for your time and feedback!

Events

Did you introduce any new tracking events?

Experiment

Did you introduce any new experiments?

Manual Testing

Caution

Please make sure existing components are not breaking/affected by this PR

Copy link

vercel bot commented Nov 12, 2024

@Anadudev is attempting to deploy a commit to the Daily Dev Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Member

@sshanzel sshanzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! :shipit:

@rebelchris wdyt?


## 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!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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!
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!


## 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](https://www.gitpod.io/docs/introduction/getting-started). 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Note:** Checkout getting started with gitPod using their [official docs](https://www.gitpod.io/docs/introduction/getting-started). 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.
**Note:** Checkout getting started with GitPod using their [official docs](https://www.gitpod.io/docs/introduction/getting-started). 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants