Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bellesea authored Aug 16, 2023
1 parent fff2cdb commit 12a322d
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,28 @@ Code under MIT License, assets may not be re-used or re-distributed.

---

## Building hackclub.com
<h1 align="center"><a href="https://hackclub.com/">Building hackclub.com</a></h1>

Hack Club's homepage is our chance to show new hackers what Hack Club could be for them. See something that could be better? Make a PR! Have an easter egg idea? Make a PR! Is the site missing something? Make a PR! _(Do you see a trend?:))_
Hack Club's homepage is our chance to show new hackers what Hack Club could be for them 💖.

### Here are a some ways to add content to the site:
See something that could be better? Make a PR! Have an easter egg idea? Make a PR! Is the site missing something? Make a PR! _(Do you see a trend?:))_

#### Create a new card
For now, if you need to add content to the site, here's how you can:

<details> <summary>Create a new card</summary>
<img width="600" alt="Screenshot 2023-08-16 at 9 09 55 PM" src="https://github.com/hackclub/site/assets/65808924/fed45800-c834-4e4c-ad87-a21e01414fa9">

Most things on the homepage are cards, modular components that can easily be added and removed according to relevancy to Hack Clubbers. There are 3 main sections: connection, open-source, and IRL community. Most new cards will likely fall within the first two sections!

First, you can create a new file under [components/index/cards]() with the name of your new event/project. Next add `import CardModel from './card-model'` and add whatever you want :) Finally, for all "call to actions", use a <Buttons> component which you can import with `import Buttons from './button'`. If it's the main CTA, use the primary prop to add a background color!

Your challenge: try and make the card as unique as possible, like a mini poster!
</details>

<details>
<summary>Add to the carousel</summary>

#### Adding to the Carousel
<img width="600" alt="Screenshot 2023-08-16 at 9 09 11 PM" src="https://github.com/hackclub/site/assets/65808924/044660eb-fb3d-43b6-a270-64a3fe51f3ca">
<img width="600" alt="Screenshot 2023-08-16 at 9 09 11 PM" src="https://github.com/hackclub/site/assets/65808924/044660eb-fb3d-43b6-a270-64a3fe51f3ca">

If there's a Hack Club or Hack Club community-led project (past or present) that Hack Clubbers can get involved in, please add it to [lib/carousel.json]() and add your card to the end of the json file. An example looks like this:
```
Expand All @@ -57,6 +62,10 @@ If there's a Hack Club or Hack Club community-led project (past or present) that
}
```

</details>

Every week, [thousands of people](https://plausible.io/hackclub.com) visit hackclub.com. What story to you want to tell?

---

Hack Club, 2023. MIT License.
Expand Down

0 comments on commit 12a322d

Please sign in to comment.