-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Delete all the files * Rebuild * Force push * Media queries * Update manifest.js (#31) updated categories and content. please review Co-authored-by: Jianmin Chen <[email protected]> * Fix cards on tablets * Update README.md * Update README.md * Make some changes --------- Co-authored-by: jianmin-chen <[email protected]> Co-authored-by: Holly Delisle <[email protected]> Co-authored-by: Jianmin Chen <[email protected]>
- Loading branch information
1 parent
4ea751e
commit 46bce3d
Showing
43 changed files
with
4,663 additions
and
4,756 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,36 @@ | ||
.now | ||
.next | ||
node_modules | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.yarn | ||
/.pnp | ||
.pnp.js | ||
.pnp.cjs | ||
.pnp.loader.mjs | ||
package-lock.json | ||
|
||
# testing | ||
/coverage | ||
|
||
# next.js | ||
/.next/ | ||
/out/ | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
.env | ||
package-lock.json | ||
*.pem | ||
|
||
# debug | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
.pnpm-debug.log* | ||
|
||
# local env files | ||
.env*.local | ||
|
||
# vercel | ||
.vercel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,36 @@ | ||
/.git | ||
/.next | ||
/node_modules | ||
package.json | ||
package-lock.json | ||
yarn.lock | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.yarn | ||
/.pnp | ||
.pnp.js | ||
.pnp.cjs | ||
.pnp.loader.mjs | ||
package-lock.json | ||
|
||
# testing | ||
/coverage | ||
|
||
# next.js | ||
/.next/ | ||
/out/ | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
*.pem | ||
|
||
# debug | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
.pnpm-debug.log* | ||
|
||
# local env files | ||
.env*.local | ||
|
||
# vercel | ||
.vercel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,103 @@ | ||
<p align="center"><img width="192" alt="Hack Club logo" src="https://assets.hackclub.com/flag-standalone.svg"></p> | ||
<h1 align="center"><a href="https://hackclub.com/">Hack Club Toolbox</a></h1> | ||
<p align="center"> | ||
<img width="192" alt="Hack Club logo" src="https://assets.hackclub.com/flag-standalone.svg"> | ||
</p> | ||
<h1 align="center"> | ||
The new <a href="https://hackclub.com/">Hack Club Toolbox</a>! | ||
</h1> | ||
|
||
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? | ||
|
||
By [@sampoder](https://github.com/sampoder) for Hack Club, 2021. MIT License. | ||
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: '<Category name>', | ||
+ color: '<Category color>', | ||
+ icon: '<Category 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 in [Slack](https://hackclub.slack.com)! |
Oops, something went wrong.
46bce3d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
toolbox – ./
toolbox.hackclub.dev
toolbox-git-main.hackclub.dev
notebook.hackclub.com
toolbox.hackclub.com