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

✨[Idea] - Website with live playground + Generator #5

Open
INeedJobToStartWork opened this issue Mar 13, 2024 · 5 comments
Open

✨[Idea] - Website with live playground + Generator #5

INeedJobToStartWork opened this issue Mar 13, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@INeedJobToStartWork
Copy link
Owner

INeedJobToStartWork commented Mar 13, 2024

Idea ✨

Interactive demo (Live playground) website with configuration generator.

How it should work?

  • Live playground for package testing
  • Configuration generator with real-time preview
  • Ability to partially modify default settings

What it gonna solve? Why we should add this?

Users will have a dedicated space to use, test, and create their own configurations.

How it should be implemented?

  • Homepage with main "Logo" and Live Playground below (If it's possible, try to change font if app "design" is bugged)

  • Config Generator Page - Configuration form on the left, live preview on the right (You should keep in mind, package have defaultConfig which can be merged with user config and partially filled [Add option to use defaultConfig or not] + config parsers + Support many exports (in commitsmile README.md) )

  • Try make it "auto update" (Especially with Config Generator)

Tech Stack:

  • Framework: React
  • MetaFramework: NextJS (App, with src, TailwindCSS)
  • Development TypeSafety: TS + @ineedj/tsconfig (Example in commitsmile package)
  • Runtime TypeSafety: Typia (Try it instead zod, if possible) (Example in commitsmile package) (Maybe you will need @ryoppippi/unplugin-typia)
  • Linter: Eslint + @ineedj/eslintrc (Example in commitsmile package, can be problem in nextjs)
  • Formatter: Prettier + @ineedj/prettierrc (Example in commitsmile package)
  • Error Handler: oh-my-error (If Needed)

(Create new workspaces dir "apps" and there "website")

Check CONTRIBUTING.MD

Example of usage / I have seen it in other library

No response

@INeedJobToStartWork INeedJobToStartWork added this to the Version 1.0.0 milestone Mar 13, 2024
@INeedJobToStartWork INeedJobToStartWork self-assigned this Mar 13, 2024
@divyanshudhruv
Copy link

Hello,
I am also interested in making a live playground. I also have nice knowledge about UI/UX and frontend.

@INeedJobToStartWork
Copy link
Owner Author

INeedJobToStartWork commented Mar 15, 2024

Hello, I am also interested in making a live playground. I also have nice knowledge about UI/UX and frontend.

Good to hear! :D
But before website, project have to be transformed into monorepo.

@divyanshudhruv
Copy link

Ok !

@INeedJobToStartWork INeedJobToStartWork added enhancement New feature or request help wanted Extra attention is needed labels Dec 16, 2024
@INeedJobToStartWork INeedJobToStartWork removed their assignment Dec 16, 2024
@divyanshudhruv
Copy link

I am ready to work on this.

@INeedJobToStartWork
Copy link
Owner Author

INeedJobToStartWork commented Dec 17, 2024

I am ready to work on this.

I did updated Requirements about site, If you are still interested i will assign you.

But Before start this task i need to upload 1.0 version (Today/Tomorrow) (edit: published)

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

No branches or pull requests

2 participants