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.

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

Jump to bottom

Feature: Add instructions for connecting new Vite React project to git repo #28107

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

Feature: Add instructions for connecting new Vite React project to git repo #28107

wants to merge 6 commits into from

Conversation

MaoShizhong
Copy link
Contributor

Because

The current Vite React setup instructions are fine but stop short of connecting a local directory to a repo on GitHub (learners will have been used to using a directory made via cloning a GH repo up to this point). How to do this is a very common question in the community.

This PR

  • Adds concise instructions for connecting a GH repo to the newly created Vite project directory
  • Adds note box with alternative instructions for creating a Vite project using a cloned GH repo
  • Moves "you can use any project name" note up to the start of the CLI commands instructions

Issue

N/A

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@github-actions github-actions bot added the Content: React Involves the React course label Jun 3, 2024
@MaoShizhong MaoShizhong mentioned this pull request Jun 3, 2024
Open
3 tasks
@MaoShizhong MaoShizhong linked an issue Jun 3, 2024 that may be closed by this pull request
React: change npm command to not nest project #28110
Open
3 tasks
@JoshDevHub JoshDevHub requested review from a team and bycdiaz and removed request for a team June 3, 2024 17:13
@MaoShizhong
Add temporary note box for ESLint VSC extension settings
a5d92e5 
Will be removed once Vite's template is updated after the dependent
plugins support flat config and ESLint v9+.
@MaoShizhong
Copy link
Contributor Author

The lint errors can be ignored as they're solely due to GitHub's intermittent "check annotations" thing with unrelated files. The one changed file for this PR doesn't contain any lint errors.

@MaoShizhong
Revert "Add temporary note box for ESLint VSC extension settings"
2a2eed9 
This reverts commit a5d92e5.

As of ESLint VSC extension v3.0.8
(https://github.com/microsoft/vscode-eslint/blob/main/README.md), the
extension checks the open workspace's ESLint dependency version to set
the "use flat config" value, which can no longer be set via a checkbox
in settings (must manually override via settings.json if necessary).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bycdiaz bycdiaz Awaiting requested review from bycdiaz bycdiaz was automatically assigned from TheOdinProject/javascript

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Content: React Involves the React course
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

React: change npm command to not nest project
1 participant
@MaoShizhong