Skip to content

Latest commit

 

History

History
127 lines (97 loc) · 4.29 KB

README.md

File metadata and controls

127 lines (97 loc) · 4.29 KB
Raw

KOSS Shield License Shield Contributors Shield


KWoC Logo

KWoC Frontend

The truth redefined, once again.
Get Started »
Kharagpur Winter of Code · Backend

Table of Contents

(back to top)

Development

See also Contributing Guide, Learning Guide.

Setting Up Locally

  • Install NodeJS.
  • Install or enable PNPM.
  • Clone this repository.
  • Run pnpm install in the cloned repository to download all dependencies.
  • Run pnpm start to start a local development server.
  • Optionally set up KWoC Backend locally.

(back to top)

Project Structure

File Structure

.
├── public
└── src
   ├── assets
   ├── components
   ├── data
   ├── hooks
   ├── styles
   ├── utils
   ├── constants.ts
   └── App.tsx
  • public: Contains public files such as index.html.
  • src: Contains source files (JS, SCSS, assets, etc.)
    • assets: Contains assets used in the source, such as images and icons.
    • components: Contains reusable react components.
    • data: Contains raw data.
    • styles: Contains all stylesheets (SCSS).
    • utils: Contains commonly used util functions.
    • pages: Contains views for each of the pages.
    • constants.ts: Contains globally used constants.
    • App.tsx: Contains the top-level App component.

Libraries/Frameworks Used

(back to top)

Archival

See also KWoC Docs.

After KWoC ends, the website is archived. The stats data (including the total PRs, total commits, total contributors, and individual stats) is copied and added to the site source.

The archived source code is committed to a branch named kwoc-xx-archive and hosted on kwocxx.kossiitkgp.org, where xx represents the last two digits of the year. The archive is also hosted on kwoc.kossiitkgp.org until the following year's website is deployed.

The development for the next KWoC website continues in the default branch.

WARNING DO NOT COMMIT ANY PERSONAL DATA TO THE ARCHIVE.

(back to top)

Acknowledgments

(back to top)

Please update this documentation whenever changes are made to this project or any other relevant project that may affect this one. Future humans will praise you.