docs

[fahad-israr]

• should explain basic workflow
• has a simple and clear guide on how to configure the app
• configure means to way to change navbar menu etc from the json
• every json file has a specific formatting for example :data,link,text etc; those should be mentioned individually
• use markdown on readme,md file
• important for the site maintainability and development

[dinskid]

Getting Started

The PWA is developed using React and Material-UI.
To get started with development run git clone https://github.com/helloworld-iiitt/iiitt.git && cd iiitt
Then run yarn install if you have yarn set-up or run npm install. This will download dependencies of the application.

Introduction

Folder Structure

• node_modules - NPM packages are stored here (No need to access this)
• public - Static files, base HTML, etc., are stored here
• src - Contains all of the source code of the website.
  • images/ - Images are stored here
    • people/faculty - Images of faculties
  • components/ - Reusable react components are store here with separate folders of their own
  • pages/ - All the pages of the site are stored here with separate folders of their own

Is this similar to something that you have in mind?

[thisisnitish]

I think there should be contribution guide

[fahad-israr]

Getting Started

The PWA is developed using React and Material-UI.
To get started with development run git clone https://github.com/helloworld-iiitt/iiitt.git && cd iiitt
Then run yarn install if you have yarn set-up or run npm install. This will download dependencies of the application.

Introduction

Folder Structure

• node_modules - NPM packages are stored here (No need to access this)

• public - Static files, base HTML, etc., are stored here

• src - Contains all of the source code of the website.

  • images/ - Images are stored here

    • people/faculty - Images of faculties

  • components/ - Reusable react components are store here with separate folders of their own

  • pages/ - All the pages of the site are stored here with separate folders of their own

Is this similar to something that you have in mind?

Refer something similar to this : https://github.com/SiddharthChillale/public-apis

[fahad-israr]

I think there should be contribution guide

Sure....for now, check out the issues and try resolving them
We're following standard contribution guidelines(the you find on any open source project).

[thisisnitish]

okk 👍🏻😊