GitHub Society

Welcome to GitHub Society, the ultimate playground where your GitHub contributions transform into a dazzling 3D cityscape! 🎨🚀

Imagine turning your coding achievements into a vibrant, rotating city of skyscrapers. With GitHub Society, you don't just track your contributions—you see them soar in a spectacular 3D environment. And the fun doesn’t stop there—you can even export your 3D city as an STL file and take your virtual skyline into the real world!

Features

• 🌟 3D Contribution City: Watch your GitHub activity bloom into a bustling metropolis of colorful towers.
• 🕹️ Interactive Controls: Rotate, zoom, and pan through your 3D cityscape with intuitive controls.
• 🎁 Export Your Model: Download your 3D creation as an STL file and showcase your coding accomplishments in the physical world.

Demo

Experience the magic of GitHub Society with our live demo: Explore the Demo

Exported Model

Installation

Ready to build your 3D contribution city? Follow these steps:

1. Clone the repository:

   git clone https://github.com/your-username/github-society.git
   cd github-society

2. Install dependencies:

   npm install

3. Create a .env file:

   NEXT_PUBLIC_GITHUB_TOKEN=your_github_token

4. Run the development server:

   npm run dev

5. Open http://localhost:3000 in your browser and watch your contributions come to life!

Usage

1. Enter your GitHub username and prepare to be amazed!
2. Watch as your contributions transform into a stunning 3D cityscape.
3. Interact with your 3D model using the controls to explore every detail.
4. Click "Export Model" to download your 3D cityscape as an STL file.

Technologies Used

• Next.js: The framework that powers your 3D adventure.
• Three.js: The library that makes 3D magic possible.
• dat.GUI: The tool that lets you tweak and control your 3D scene.
• GitHub API: Where all your contribution data comes from.

Exported 3D Model

Check out the models directory to find an example of the 3D model exported from GitHub Society.

Contributing

Got ideas to make GitHub Society even cooler? Here's how you can help:

1. Fork the repository.
2. Create a new branch: git checkout -b my-awesome-feature
3. Make your changes and commit them: git commit -m 'Add something awesome'
4. Push to your branch: git push origin my-awesome-feature
5. Submit a pull request and share your magic with the world!

Contact

• Author: Chirag Badhe
• Email: 0xchirag@gmail.com
• Twitter: @0xchirag