gdsc-uic / guilds

Club directory website for the UIC Club Fair.
http://guilds.gdscuic.org/
2 stars 6 forks source link
Guilds Logo

The club directory website for the UIC Club Fair 2024

https://guilds.gdscuic.org

Club Submission

For clubs

Please submit your information in this Google Drive Link.

For developers

Guilds uses real Markdown files (ending in .md) as the database for keeping club data. Here are the following things you can do to add your club:

  1. Create a folder inside the src/clubs directory. Be sure that the name only contains lowercase alphabets, numbers, and only dashes. Dashes are used to substitute spaces in this case (Club XYZ -> club-xyz)
  2. Inside the folder, create an index.md file. This is where most of your club's information be displayed. The following is the format:
---
name: Club XYZ
description: Your #1 club!
---

# Pictures and other information goes here
  1. Save and create a pull request.

Development

The Guilds website is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Contributors

Made with contrib.rocks.

(c) 2022 Google Developer Student Clubs of UIC