kaustav202 / hacktobered.com

Have you contributed to Open-source? Now it's time to show off to the world!

Hacktobered.com

I decided to build this fun project during Hacktoberfest 2022. Here are some details about its initial idea / problem statement, tech stack, how you can contribute, etc.

Initial Idea / Problem Statement

• I am a developer and made (Or am planning to) open-source contributions during HacktoberFest.
• Now, how can I share my hacktober achievements with others? Can I share via Instagram stories / WhatsApp Status / Twitter?
• You can do it manually - copy and paste your PR links; create milestones and progress cards for social posts.
• Is there any tool that simplifies the above manual steps?
• Nope 😐!

Let us build then!

Proposed user flow

An easy task to pick up is creating more user cards like the one below:

Getting Started

1. Install npm Dependencies:

npm i
# or
yarn

2. Create .env.local file and copy content of .env.local.example.

3. Create NEXTAUTH_SECRET - # Linux: openssl rand -hex 32 or go to https://generate-secret.now.sh/32

4. Create Github OAuth App . Copy Client ID and Client Secret into GITHUB_ID and GITHUB_SECRET.

5. If you want to save logged-in user details, you can use mongo db. Provide connection details in .env.local. However if you don't want - make sure to comment line 4 and line 14 in pages\api\auth[...nextauth].tsx before running the code.

    //import clientPromise from "../../../lib/mongodb";
     //adapter: MongoDBAdapter(clientPromise),

6. Run the development server:

npm run dev
# or
yarn dev

7. Open http://localhost:3000 with your browser to see the result.

Facing any issues? Feel free to open a ticket.

How to contribute

• Fork this repo.
• Open an issue. Get it triaged/approved first if in doubt. I'll add "Triaged" label in such tasks.
• Read CONTRIBUTING.md
• Send PRs against dev branch only.

Tech Stack:

• React, Next.js, Typescript
• Chakra UI component library
• Next-Auth
• (Optional) MongoDB - if you want to save user details.