search

javascriptcraft / javascript-craft

This is the library for the creating a component generator for javascript library
7 stars 3 forks source link

Final document of the component-generator app #1

Open javascriptcraft opened 4 years ago

OliverGtz commented 4 years ago

I have a template of a SRS (Software Requirements Specification) for a software engineering class I took (developed an iOS app). I can upload it if you think we need one.

AkromDev commented 4 years ago

Project concept.

We will build a platform where we keep collection of custom UI elements/components in different categories. For example in Select category. We will have different types of Select components such as Simple Select, Searchable Select, Multi-Select. Each component will have different options listed below it.

  1. View code
  2. Open code in editor (either external editor like codepen or our cloud editor)
  3. Save/Bookmark Component
  4. Discuss (which will open a discussion page like in guthub issues)
  5. Upvote/Like
  6. Component Creator account/ top contributors ??? (TBD)

This is MVP. In v2, we will allow users to create their own components and keep them either private or public. And they can decide to publish thier component by submitting their code to our featured components. And they will be published after reviewing.

FAQ: Q: Is this similar to bootstrap? A: no, all of these components will be independent component and you don’t need to download the css framework to use them. You can view its code, play with it in editor and discuss about it if you didn’t understand it. You can copy the code and use it in your projects and modify it. You can raise PR if it has bugs.

Q: What stack will be used? A: We haven’t decided on stack yet but everything will be JavaScript (maybe + Typescript). Since each component will have examples in vanilla JavaScript, ReactJs, VueJs etc.., you can still contribute and learn no matter what stack will be. I think Backend will be NodeJs, ExpressJs (TBB)

AkromDev commented 4 years ago

I have a template of a SRS (Software Requirements Specification) for a software engineering class I took (developed an iOS app). I can upload it if you think we need one.

That would be great. I just wrote the main concept but I think we need better documentation later.