ROASTHUB

Built with the tools and technologies:

Overview

a github profile roaster enhanced with the help of gemini model 3B.

---

Project Structure

└── RoastHub/
    ├── .github
    │   └── workflows
    ├── README.md
    ├── app
    │   ├── favicon.ico
    │   ├── globals.css
    │   ├── layout.tsx
    │   └── page.tsx
    ├── components
    │   └── Dialog.tsx
    ├── eslint.config.mjs
    ├── next.config.ts
    ├── package-lock.json
    ├── package.json
    ├── postcss.config.mjs
    ├── public
    │   ├── file.svg
    │   ├── globe.svg
    │   ├── next.svg
    │   ├── vercel.svg
    │   └── window.svg
    └── tsconfig.json

Project Index

ROASTHUB/

__root__

package-lock.json	❯ REPLACE-ME
next.config.ts	❯ REPLACE-ME
tsconfig.json	❯ REPLACE-ME
eslint.config.mjs	❯ REPLACE-ME
postcss.config.mjs	❯ REPLACE-ME
package.json	❯ REPLACE-ME

.github

workflows

nextjs.yml

❯ REPLACE-ME

components

Dialog.tsx

❯ REPLACE-ME

app

layout.tsx	❯ REPLACE-ME
globals.css	❯ REPLACE-ME
page.tsx	❯ REPLACE-ME

---

Getting Started

Prerequisites

Before getting started with RoastHub, ensure your runtime environment meets the following requirements:

• Programming Language: Error detecting primary_language: {'json': 3, 'ts': 1, 'mjs': 2, 'yml': 1, 'tsx': 3, 'css': 1}
• Package Manager: Npm

Installation

Install RoastHub using one of the following methods:

Build from source:

1. Clone the RoastHub repository:

❯ git clone https://github.com/JaswanthRemiel/RoastHub

2. Navigate to the project directory:

❯ cd RoastHub

3. Install the project dependencies:

Using npm  

❯ npm install

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the RoastHub project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/JaswanthRemiel/RoastHub

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---