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

Create a NextJS example to reside in the NextJS repository #14245

Closed
tay1orjones opened this issue Jul 19, 2023 · 15 comments
Closed

Create a NextJS example to reside in the NextJS repository #14245

tay1orjones opened this issue Jul 19, 2023 · 15 comments
Assignees
Labels
needs: community contribution Due to roadmap and resource availability, we are looking for outside contributions on this issue. proposal: accepted This request has gone through triaging and we are accepting PR's against it. type: enhancement 💡 type: infrastructure 🤖 Issues relating to devops, tech debt, etc.

Comments

@tay1orjones
Copy link
Member

tay1orjones commented Jul 19, 2023

It would be beneficial for our users and maintainers if there was an easy way to spin up a NextJS app with the latest Carbon deps included and set up.

If we create an example and submit it to the examples folder in the next.js repo under the name carbon-design-system

This will enable users to use a command like this to spin up a NextJS project using @carbon/react:

npx create-next-app --example carbon-design-system carbon-design-system-app

We may want to reuse some of the assets, layout, etc from the tutorial if/after it's updated to NextJS instead of react-scripts, carbon-design-system/carbon-tutorial#10994

@tay1orjones tay1orjones moved this to ⏱ Backlog in Design System Jul 19, 2023
@github-project-automation github-project-automation bot moved this to Triage in Roadmap Jul 19, 2023
@sstrubberg sstrubberg moved this from Triage to Next in Roadmap Aug 9, 2023
@sstrubberg sstrubberg added this to the 2023 Q3 milestone Aug 9, 2023
@sstrubberg sstrubberg added proposal: accepted This request has gone through triaging and we are accepting PR's against it. needs: community contribution Due to roadmap and resource availability, we are looking for outside contributions on this issue. labels Sep 25, 2023
@github-actions
Copy link
Contributor

The Carbon team has accepted this proposal! Our team doesn’t have the cycles to work on this now, so we are requesting community contributors. Please see the labels for roles that are needed. If you are willing to help out, comment below and we will get in touch!

@sstrubberg sstrubberg removed the needs: community contribution Due to roadmap and resource availability, we are looking for outside contributions on this issue. label Sep 25, 2023
@tay1orjones tay1orjones modified the milestones: 2023 Q3, 2023 Q4 Oct 2, 2023
@tay1orjones tay1orjones moved this from Next to Now in Roadmap Oct 2, 2023
@Shankar-CodeJunkie
Copy link
Contributor

@tay1orjones : Is this request still open ? Can I work on this issue

@tay1orjones
Copy link
Member Author

Hey, I so appreciate your willingness to take this on! We just spoke about this as a team earlier today and right now we're actually going to place this idea on hold. There's lots of additional follow-on considerations that we're not able to handle right now.

@sstrubberg
Copy link
Member

Hey @Shankar-CodeJunkie, i'm curious, what did you have in mind when the user ran the npx command to create a next app with Carbon bundled in? As in, what would the landing page look like?

@Shankar-CodeJunkie
Copy link
Contributor

Shankar-CodeJunkie commented Nov 27, 2023

Hi @sstrubberg ! Apologies for late response . We can have the same landing page like what we had on Create React Template. We can also point to something different as well, may be we can come up with something very new as well.

@sstrubberg
Copy link
Member

Hi @sstrubberg ! Apologies for late response . We can have the same landing page like what we had on Create React Template. We can also point to something different as well, may be we can come up with something very new as well.

This is great @Shankar-CodeJunkie. Let's use the same template you used for the CRA template as a starting point. Thank you for contributing to not only Carbon, but to NextJs as well! 🎉

@sstrubberg sstrubberg moved this to 📋 Backlog in Community Workgroups Nov 27, 2023
@sstrubberg sstrubberg removed this from the 2023 Q4 milestone Nov 27, 2023
@sstrubberg sstrubberg added type: infrastructure 🤖 Issues relating to devops, tech debt, etc. needs: community contribution Due to roadmap and resource availability, we are looking for outside contributions on this issue. labels Nov 27, 2023
Copy link
Contributor

The Carbon team has accepted this proposal! Our team doesn't have the capacity to work on this now, so we are requesting community contributors. Please see the labels for roles that are needed. If you are willing to help out, comment below and we will get in touch!

@Shankar-CodeJunkie
Copy link
Contributor

@sstrubberg ! Thanks for your response. I will start working on this item, and keep you informed on the progress. Can you please assign this story to me . Thanks

@guidari guidari moved this from 📋 Backlog to 🏗 In progress in Community Workgroups Nov 29, 2023
@Shankar-CodeJunkie
Copy link
Contributor

I'm working for this issue, with the goal of completing it within the next two weeks. However, the holiday season has caused it to take a backseat for the time being.

@Shankar-CodeJunkie
Copy link
Contributor

Hi @sstrubberg @tay1orjones

I've completed creating the nextjs-starter using javascript and mainly re-used code from the tutorial repository , also added a theme switcher for user to explore themes provided by Carbon. We used the very same template for create-next-app as well.

npx create-next-app@latest project-name --example https://github.com/Shankar-CodeJunkie/carbon-design-system-nextjs-starter

Can I myself upload the repository under the name [carbon-design-system] on vercel repo examples

I'am also working to create a typescript starter under the name [carbon-design-system-with-typescript]

image

@Shankar-CodeJunkie
Copy link
Contributor

Hi @sstrubberg @tay1orjones

I've also created a starter for typescript as well. You can find the repositories here

We can upload these two separate starter projects under the names [carbon-design-system] and [carbon-design-system-with-typescript] in vercel example directory.

@tay1orjones
Copy link
Member Author

@Shankar-CodeJunkie sounds good to me, thank you!

@Shankar-CodeJunkie
Copy link
Contributor

@tay1orjones : Can I upload those templates using my ID and if so , when can I upload it ?

@tay1orjones
Copy link
Member Author

@Shankar-CodeJunkie Yes your ID is fine. You can add them to the vercel example directory/repo right now. Post the PR link to this issue and when it's merged we can close this issue. Thank you again

@Shankar-CodeJunkie
Copy link
Contributor

Thanks @tay1orjones

I've created a pull request 60394 in the nextjs repository and awaiting for their review comments. I will keep you informed in the updates of that pull request.

Thank you

@github-project-automation github-project-automation bot moved this from Now to Completed in Roadmap Jun 6, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Community Workgroups Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: community contribution Due to roadmap and resource availability, we are looking for outside contributions on this issue. proposal: accepted This request has gone through triaging and we are accepting PR's against it. type: enhancement 💡 type: infrastructure 🤖 Issues relating to devops, tech debt, etc.
Projects
Status: Done
Archived in project
Development

No branches or pull requests

3 participants