Skip to content

Latest commit

 

History

History
164 lines (132 loc) · 6.33 KB

README.md

File metadata and controls

164 lines (132 loc) · 6.33 KB
Raw

Byld Website 2.0

React Astro Tailwind shadcn/ui

Complete Rewrite of the old Byld website using modern tools

Contributing

To contribute to this code:

  • Create a Fork of the repository

  • Clone the repository localy:

    git clone https://github.com/IIIT-Delhi/byld-website-2.0.git

  • Install all the packages:

    npm install

  • Start the development server:

    npm run dev

  • Make the changes as needed and commit with an appropriate message, we don't mandate a template for the git messages, but be descriptive. Take a look at other commits for reference.

  • Once done revisit your fork and you would find a button to contribute, click this.

  • This will open a pull request for your changes to the repository. Now wait for your pull request to be reviewed and merged.

Tools used

We will not go in depth about the tools used here, please refere the documentation of the tools used in here, the links have been attached.

Directory structure

.
├── astro.config.mjs
├── components.json
├── package.json
├── package-lock.json
├── public
│   ├── favicon.svg
│   ├── fonts
│   │   └── Kusanagi.woff
│   ├── left.svg
│   ├── logo.svg
│   └── right.svg
├── README.md
├── src
│   ├── assets
│   │   ├── byld-logo.png
│   │   ├── hackathons.jpg
│   │   ├── hacknights.jpg
│   │   ├── iiitd-logo.png
│   │   ├── logo2.jpg
│   │   ├── members-images
│   │   │   ├── anirudh.jpg
│   │   │   ├── armaan.jpg
│   │   │   ├── devansh.jpg
│   │   │   ├── harsh.jpg
│   │   │   ├── raghav.jpg
│   │   │   ├── shiv.jpg
│   │   │   ├── tharun.jpg
│   │   │   ├── vickey.jpg
│   │   │   └── vikranth.jpg
│   │   └── techtalks.jpg
│   ├── components
│   │   ├── About.astro
│   │   ├── EventCard.tsx
│   │   ├── Events.astro
│   │   ├── Footer.astro
│   │   ├── Hero.astro
│   │   ├── HomeEventCards.tsx
│   │   ├── Navbar.tsx
│   │   ├── Projectcards.tsx
│   │   ├── Projects.astro
│   │   └── ui
│   │       ├── button.tsx
│   │       ├── card.tsx
│   │       ├── navigation-menu.tsx
│   │       └── table.tsx
│   ├── content
│   │   ├── config.ts
│   │   ├── hackathons
│   │   │   ├── devhaven.md
│   │   │   └── hackathon-1.md
│   │   ├── hacknights
│   │   │   └── hacknight-1.md
│   │   ├── home
│   │   │   ├── eve.tsx
│   │   │   └── projects.json
│   │   ├── members
│   │   │   └── member.tsx
│   │   └── techtalks
│   │       └── techtalk-1.md
│   ├── env.d.ts
│   ├── layouts
│   │   └── MySiteLayout.astro
│   ├── lib
│   │   └── utils.ts
│   ├── pages
│   │   ├── 404.astro
│   │   ├── hackathons.astro
│   │   ├── hacknights.astro
│   │   ├── index.astro
│   │   ├── members.astro
│   │   ├── memburs.astro
│   │   └── techtalks.astro
│   └── styles
│       └── globals.css
├── tailwind.config.js
└── tsconfig.json
  • src/ - root of the whole project
  • tailiwind.config.js - config for your tailwind files
  • src/components - all the components are stored here
  • src/components/ui - contains all the shadcn components, don't change things in this manually, unless you absolutely want to.
  • src/pages - All the pages in the website are stored here
  • src/styles/globals.css - The top-level and only css file in the whole thing, custom classes put here.
  • src/layouts - this directory contains the layouts for your pages
  • src/content - contains all the content that is to be rendered on events pages (hackathons, hacknights, techtalks) as well as projects and events section of the homepage.

Where and how to change content?

To edit events or projects on homepage

You can edit according to the format of eve.tsx (events section) and projects.json (projects section) under the src/content/home directory to change the events and projects

To add a new event

Just create a markdown file for your event under the correct directory. For example: let's say a hackathon "dummy hackathon" happened, then you will create a markdown file for it under the src/content/hackathons directory. Do not worry about sorting them into upcoming and past events, the event page will automatically sort it based on the date.

To edit members

Edit the src/content/members/member.tsx file to change members.

Notes

  • If someone encounters an error when using shadcn ui, like with nested ui components from it, for example, some error like: Component A needs to be inside Component B and you already have A inside B then try looking into this article and the Navbar.tsx file in the components directory. This problem is caused by Astro's island architecture.

License

This project is licensed under the MIT License.