https://github.com/hackclub/scrapbook
🔥 A daily streak system & portfolio for your projects.
https://github.com/hackclub/scrapbook
hackclub hacktoberfest nextjs summer-of-making
Last synced: about 2 months ago
JSON representation
🔥 A daily streak system & portfolio for your projects.
- Host: GitHub
- URL: https://github.com/hackclub/scrapbook
- Owner: hackclub
- Created: 2020-06-11T18:50:24.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T09:46:25.000Z (8 months ago)
- Last Synced: 2024-08-27T11:02:40.708Z (8 months ago)
- Topics: hackclub, hacktoberfest, nextjs, summer-of-making
- Language: JavaScript
- Homepage: https://scrapbook.hackclub.com
- Size: 4.58 MB
- Stars: 169
- Watchers: 10
- Forks: 47
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-hackathon - Scrapbook - A daily streak system & portfolio for your projects. (Tooling / Promoting)
README
# Scrapbook
Scrapbook helps you **share the things you're working on every day!** As a [Hack Clubber](https://hackclub.com/), 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
1. **Clone the repository:**
```sh
git clone https://github.com/hackclub/scrapbook.git
cd scrapbook
```
2. **Install dependencies:**
```shell
yarn deps-install
```
3. **Request the .env file:**
Send a message mentioning @creds in Hack Club's Slack asking for the .env file.
4. **Start the development server:**
```shell
yarn dev
```
5. View your server: Open your browser and navigate to http://localhost:3000/.
## Build Commands
### Build the web application:
```sh
yarn build:web
```
### Check code formatting:
```sh
yarn checkFormat
```
### Format code for Slack bot
```sh
yarn prettier:slack-bot
```
### Format code for web app
```sh
yarn prettier:web
```