Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 3 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,12 @@
# Penn State Communities Index
# *(fork of)* Penn State Communities Index

![PSCI Banner](github.png)

The **Penn State Communities Index** is an unofficial initiative aimed at fostering community and connection among Penn State students. This lightweight and efficient project provides a centralized platform to discover and join various group chats (GCs) for different interests, classes, and communities within Penn State.

## Features
## Why did I make this fork?

- **Dynamic Tag Filtering**: Easily filter communities by tags like "Class of 2029," "Residence Halls," or "Recently Added."
- **Search Functionality**: Quickly search for communities by name, description, or tags.
- **Responsive Design**: Fully responsive layout optimized for both desktop and mobile devices.
- **Lightweight Codebase**: The entire project is less than **100kB**, making it fast and efficient to load.
- **Customizable Tags**: Tags are dynamically generated and can be easily updated.

## Contribution Guide

We welcome contributions to make PSCI even better! Follow these simple steps to add new group chats (GCs) or improve the project:

1. **Install TailwindCSS CLI**:

```bash
npm install tailwindcss @tailwindcss/cli
```

2. **Create an `input.css` File**:
In the root directory, create a file named `input.css` and add the following line:

```css
@import "tailwindcss";
```

3. **Clone the Repository**:
Clone this repository into a `src` folder:

```bash
git clone https://github.com/PSCIndex/PSCIndex.github.io src
```

4. **Generate the CSS**:
Run the following command to generate the `styles.css` file:

```bash
npx @tailwindcss/cli -i ./input.css -o ./src/styles.css --watch --minify --optimize
```

5. **Add New Communities**:

- Open the `src/index.html` file.
- Add a new community card in the `#communities-grid` section. Use the existing cards as a template.
- Ensure the `data-tags` & `data-date` attributes are updated with relevant information for filtering.

6. **Commit and Push**:
Once you've made your changes, commit and push them to the repository. After that, create a pull request for review.

## Credits

This project is made possible by the efforts of the following individuals:

- **XelXen** - Lead Developer
- **Anshoeman7** - Contributor
- **Amrutha** - Representative
Becasue **[XelXen](https://github.com/XelXen)** loves blinding people.

---

Expand Down
Loading