HA
hackclub/scrapbook
๐ฅ A daily streak system & portfolio for your projects.
Scrapbook
Scrapbook helps you share the things you're working on every day! As a Hack Clubber, you are always learning and building things. Scrapbook allows you to share updates on the things you're doing with the rest of the Hack Club community, and keeps you motivated by recording each day you contribute, tallying that up onto a streak shown on your profile.
How to Set Up the Project
- Clone the repository:
git clone https://github.com/hackclub/scrapbook.git
cd scrapbook- Install dependencies:
yarn deps-install-
Request the .env file:
Send a message mentioning @creds in Hack Club's Slack asking for the .env file. -
Start the development server:
yarn dev- View your server: Open your browser and navigate to http://localhost:3000/.
Build Commands
Build the web application:
yarn build:webCheck code formatting:
yarn checkFormat Format code for Slack bot
yarn prettier:slack-bot Format code for web app
yarn prettier:webRun the codemod for commenting the lines
npx jscodeshift \
-t scripts/codemods/comment-console-logs.js \
apps/web apps/slack-bot \
--extensions=js,jsx \
--ignore-pattern '**/node_modules/**'