yoganshsharma / yakw

Yet Another KOSS Website

YAKW - Yet Another KOSS Website

This is the repository for development of (yet another) new and improved KOSS website. Currently deployed at https://beta.kossiitkgp.org and under heavy development.

This website is created using Astro.

Table of Contents

• Development
  • Website Design
  • Setting Up Locally
  • Yarn Commands
• Project Structure
  • File Structure
  • Routes

Development

Website Design

• The designing of this website is being done in figma. Please refer to this file.
• For edit permissions please request for the same in figma.

Setting Up Locally

• Install the latest version of NodeJS.
• Install Yarn the package manager used in this project instead of npm. See the Yarn docs for installation instructions.
• Clone this repository.
• Run yarn install in a terminal to install all the dependencies.
• Run yarn dev to start a local development server at http://localhost:3000.
• Optional: Install the official Astro language extension in VSCode to enable syntax highlighting and intellisense for .astro files.

Yarn Commands

All commands are run from the root of the project, from a terminal:

Command	Action
yarn install	Installs dependencies
yarn dev	Starts local dev server at localhost:3000
yarn build	Build your production site to ./dist/
yarn preview	Preview your build locally, before deploying
yarn astro ...	Run CLI commands like astro add, astro check
yarn astro -- --help	Get help using the Astro CLI

Project Structure

File Structure

/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

Routes

• / (Index)
  • File: src/pages/index.astro.

---

Please update this documentation if you make changes to the KOSS website. Future humans will praise you.