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

Overview

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

Basic User Flow

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

cheerCard_small

Getting Started

  1. Install npm Dependencies:
npm i
# or
yarn
  1. Create .env.local file and copy content of .env.local.example.

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

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

  4. 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),
  5. Run the development server:

npm run dev
# or
yarn dev
  1. Open http://localhost:3000 with your browser to see the result.

Facing any issues? Feel free to open a ticket.

How to contribute

  • Drop a on the Github repository (optional)

  • Before Contribute Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md

  • Create an issue of the project or a feature you would like to add in the project and get the task assigned for youself.(Issue can be any bug fixes or any feature you want to add in this project).

  • Fork the repo to your Github.

  • Clone the Repo by going to your local Git Client in a particular local folder in your local machine by using this command with your forked repository link in place of below given link:
    git clone https://github.com/<please write your git username here>/hacktobered.com.git

  • Create a branch using below command. git branch <your branch name>

  • Checkout to your branch. git checkout <your branch name>

  • Add your code in your local machine folder. git add .

  • Commit your changes. git commit -m "<add your message here>"

  • Push your changes. git push --set-upstream origin <your branch name>

  • Make a pull request! (compare your branch with the owner main branch)

Tech Stack:

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

Our Amazing Contributors



Show some ❤️ by starring this awesome repository!

Comments
  • Automatic update to Dependencies using Dependabot.

    Automatic update to Dependencies using Dependabot.

    Added Dependabot configuration to automatically check for updates on packages on a weekly basis. It will also create a PR whenever there is an update.
 Fixes: Issue - 52

    opened by The-Reverse-Flash 9
  • Show

    Show "how to" content for the users without pull requests

    If the logged-in user does not have any existing pull requests - Show them some helpful content on how they can participate in Hacktoberfest. Provide the link to the main event website. Find useful resources and put links.

    good first issue Frontend 
    opened by ankitwww 7
  • Create dependabot.yml

    Create dependabot.yml

    Automatic update to Dependencies using Dependabot. Added Dependabot configuration to automatically check for updates on packages on a weekly basis. It will also create a PR whenever there is an update.
 Fixes: Issue - 52

    hacktoberfest-accepted 
    opened by The-Reverse-Flash 5
  • Remove Share button from the CheerCard

    Remove Share button from the CheerCard

    Take a look at #11 and its PR. We need a similar change for components\PullRequestDetailCards\CheerCard.tsx We need to remove the share button from the generated image

    image

    good first issue Frontend 
    opened by ankitwww 3
  • Refactor Types folder

    Refactor Types folder

    Separate every type in a single file, and fix their references across the repo. types\SearchResults.tsx can be ignored, but PREntry needs to be broken into single file and a better name

    good first issue 
    opened by ankitwww 3
  • Fix logo at Nav bar

    Fix logo at Nav bar

    We don't have logo at nav bar (desktop as well mobile - check once though). image

    Lots of files are available in public folder. Also, this - https://hacktobered.s3.us-west-2.amazonaws.com/hacktobered.png

    good first issue Frontend 
    opened by ankitwww 3
  • More direct share options

    More direct share options

    Although the generic share button covers all native scenarios on mobile, desktop experience is not great. User can only download the image. We should provide more options to share

    enhancement help wanted Frontend 
    opened by ankitwww 2
  • Home Page enhancement

    Home Page enhancement

    Currently, the home page is pretty basic. We should make it full-fledged with content covering 'Why you should use it?', And 'we created it', etc. Ideas are welcome!!!

    good first issue help wanted 
    opened by ankitwww 7
How often do you get asked about the gadgets or software that you use? If the answer is quite often, you should be trying show off out. Curate the list of gadgets and software and share it with your fans and followers.

Show Off - Showcase your setup! How often do you get asked about the gadgets or software that you use? If the answer is quite often, you should be try

Adithya Sreyaj 15 Nov 24, 2022
Keep a track of all the tasks you need to do and Check off ones you have completed - Created using HTML, SCSS, JavaScript and Webpack.

To Do List Keep a track of tasks you need to do. An Application where you can keep a track of the tasks you need to do and checkout the ones that have

Awais Amjed 19 Jul 28, 2022
Get into docker, its time now hhh

get_into_docker This repo is a personal reference and a guide in case of need that holds the process on my activities. This repo is a kind of knowledg

Essadeq ELAAMIRI 6 Nov 1, 2022
They stole our free learn feature, so it's now time for an open source variant

Quizletbutfree This project was generated using Nx. ?? Smart, Fast and Extensible Build System Quick Start & Documentation Nx Documentation 10-minute

zerxal 2 Nov 13, 2022
A community contributed game system for Pathfinder Second Edition.

The Official Pathfinder Second Edition Game System for FoundryVTT This system uses trademarks and/or copyrights owned by Paizo Inc., which are used wi

Foundry Virtual Tabletop 104 Jan 5, 2023
A social-media mock app for the ones who love to read - and maybe show it off

?? ?? Cachalote ?? ?? Share what you are reading and find people who also likes it - or not! What does it do? This app focuses on three main questions

Thaís França 3 May 22, 2022
zieeco 12 Jul 8, 2022
It's a repository to studies. Its idea is to learn about Nx and its plugins.

StudyingNx This project was generated using Nx. ?? Smart, Fast and Extensible Build System Adding capabilities to your workspace Nx supports many plug

Open-ish 4 May 13, 2022
Can see everything, beware of its omniscience, kneel before its greatness.

Can see everything, beware of its omniscience, kneel before its greatness. Summary Presentation Installation Removing Credits Presentation Main goal T

Duc Justin 3 Sep 30, 2022
🥰 Mini world simulator is a terminal application made in JavaScript to control the world that is being generated.

Mini-world "Simulator" Mini world simulator is a terminal application made in JavaScript to control the world that is being generated. It has no other

Adrián 2 Mar 14, 2022
An App that uses an external APIs to show meals from around the world

This website displays recipes meals using APIs to retrieve details from a DataBase and also implements features like adding a functional Like button for every item and a section for adding a new comment. All these through an external API to send and receive data.

Fernando Salas 4 Mar 12, 2022
TVMAZE API-based webapp, receives TV show episodes with all data about that TV show.

TVMAZE API-based webapp, receives TV show episodes with all data about that TV show. The Webapp has two interfaces: A home page, showing a list of Tv show episodes you can like. And a popup window with more data about the TV show that you can comment on.

Yasin Warsame 4 Aug 9, 2022
Write "hello world" in your native language, code "hello world" in your favorite programming language!

Hello World, All languages! ?? ?? Write "hello world" in your native language, code "hello world" in your favorite language! #hacktoberfest2022 How to

Carolina Calixto 6 Dec 13, 2022
A simple browser extension, intended to get you "Back To Work" when you start slacking off to one of those really addictive sites.

Back to Work A simple browser extension, intended to get you Back To Work when you start slacking off to one of those really addictive sites. What doe

Dheeraj Lalwani 29 Nov 19, 2022
Open Source REST API for the best league in the world

NBA REST API Open Source REST API for the best league in the world! We are not affiliated, associated, authorized, endorsed by, or in any way official

Francisco Panozzo 16 Nov 6, 2022
The world's greatest open source 3D CAM software. (Maybe one day.)

Meshmill is open source 3D CAM software for Linux. It turns STL models into G-code for CNC machines. This is beta-quality software. Use it at your own

James Stanley 20 Dec 21, 2022
Lucid is a library, which allows you to create Cardano transactions and off-chain code for your Plutus contracts in JavaScript and Node.js.

Lucid is a library, which allows you to create Cardano transactions and off-chain code for your Plutus contracts in JavaScript and Node.js.

Berry 243 Jan 8, 2023