Ember

AI-powered GitHub roaster with Friendly or Brutal mode
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgments

About The Project

Ember is a GitHub profile roaster that delivers AI-generated feedback in three tones: Friendly, Savage, or Brutal. It analyzes your stars, repos, and followers to generate fun, insightful, or brutal roasts. Built as a minimal side project to experiment with frontend design, AI prompts, and the OpenRouter API.

(back to top)

Built With

These are the main frameworks and libraries used to build Ember. Additional tools and assets are listed in the Acknowledgements section.

(back to top)

Getting Started

Follow these steps to get a local copy of Ember up and running on your machine.

Prerequisites

You’ll need the following installed:

• Node.js (v20+)
• npm (v10+)

  npm install npm@latest -g
  

• OpenRouter API key
• Github Account Token

Installation

1. Clone the repo

   git clone https://github.com/vxnsh1/ember.git
   cd ember
   

2. Install dependencies

   npm install
   

3. Set up environment variables Create a .env.local file in the root directory and add:

     GITHUB_TOKEN=your_github_token
     OPENROUTER_API_KEY=your_openrouter_api_key

4. Run the development server

   npm run dev
   

   Open http://localhost:3000 to view the app in your browser.

(back to top)

Contributing

Contributions help make Ember better for everyone! Whether it’s fixing bugs, adding new lessons, or improving the UI/UX, your contributions are greatly appreciated.

If you have ideas or suggestions:

1. Fork the repository
2. Open an issue with the tag "enhancement" or "bug"

How to Contribute

1. Fork the project

2. Create your feature branch

   git checkout -b feature/AmazingFeature
   

3. Commit your changes

   git commit -m "Add some AmazingFeature"
   

4. Push to your branch

   git push origin feature/AmazingFeature
   

5. Open a Pull Request and describe your changes.
   
   

Don’t forget to give the project a ⭐ if you like it!

(back to top)

Contact

Vansh Chouhan - @vanshchouhan

(back to top)

Acknowledgments

• OpenRouter
• Vercel
• Lucide Icons

(back to top)