An open API service indexing awesome lists of open source software.

https://github.com/hackclub/toolbox

🧰 Deals for Hack Clubbers.
https://github.com/hackclub/toolbox

Last synced: about 2 months ago
JSON representation

🧰 Deals for Hack Clubbers.

Awesome Lists containing this project

README

          


Hack Club logo



The new Hack Club Toolbox!

Deals for Hack Clubbers—powered by [Next.js], [Theme UI] & [MDX].

[next.js]: https://nextjs.org
[mdx]: https://mdxjs.com
[theme ui]: http://theme-ui.com

## How do I add a card?

All the cards except for the current ones are stored in `manifest.js`. If you take a look at it, you'll notice it's in JSON:

```js
export default [
{
category: 'Perks',
color: 'primary',
icon: 'bag',
items: [
{
name: 'Zoom Pro Meetings',
description: 'Run Zoom Pro meetings for free in your Hack Club',
icon: 'welcome',
external: false,
url: '/zoom.mdx',
forUseBy: 'clubbers'
},
...
]
},
...
]
```

To add a card to an existing category, you simply add to the cards in the category, like so:

```diff
export default [
{
category: 'Perks',
color: 'primary',
icon: 'bag',
items: [
{
name: 'Zoom Pro Meetings',
description: 'Run Zoom Pro meetings for free in your Hack Club',
icon: 'welcome',
external: false,
url: '/zoom.mdx',
forUseBy: 'clubbers'
},
+ {
+ name: 'Theme',
+ description: "Hack Club's theme, using Theme UI",
+ icon: 'grid',
+ external: true,
+ url: 'https://theme.hackclub.com',
+ forUseBy: 'everyone'
+ }
]
},
```

To add a new category, you'll follow a similar pattern at the bottom of the file:

```diff
export default [
{
category: 'Perks',
color: 'primary',
icon: 'bag',
items: [
{
name: 'Zoom Pro Meetings',
description: 'Run Zoom Pro meetings for free in your Hack Club',
icon: 'welcome',
external: false,
url: '/zoom.mdx',
forUseBy: 'clubbers'
},
]
},
+ {
+ category: '',
+ color: '',
+ icon: ''
+ items: [
+ ...
+ ]
+ }
]
```

_For `color` and `icon`, you can use [Hack Club's theme](https://theme.hackclub.com)._

When you edit the file to make these changes, you'll be asked to make a pull request.

Let us know if you have any questions (or find any issues) in the #leaders channel on [our Slack](https://hackclub.com/slack) or email clubs@hackclub.com