Code Monkey home page Code Monkey logo

hacktobered.com's Introduction

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

  • 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.

hacktobered.com's People

Contributors

ankitwww avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.