Icebreaker Frame

Welcome to the Icebreaker Frame repository! This project aims to provide a simple interface for looking up Icebreaker-contextual details about Farcaster users.

Local Installation

To get started with Icebreaker Frame, clone the repository and install the necessary dependencies:

git clone https://github.com/icebreakerlabs/icebreaker-frame.git
cd icebreaker-frame
npm install

Usage

After installation, you can start the application with:

npm run dev

Navigate to http://localhost:5173/api/dev in your web browser to access the application.

Contributing

We welcome contributions to Icebreaker Frame! To contribute, please follow these steps:

1. Fork the repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.
2. Clone your fork: Clone your forked repository to your local machine.

git clone https://github.com/yourusername/icebreaker-frame.git

3. Create a new branch: Create a new branch for your feature or bugfix.

git checkout -b my-feature-branch

4. Make your changes: Implement your feature or bugfix.
5. Commit your changes: Commit your changes with a descriptive commit message.

git add .
git commit -m "Add feature X"

6. Push to your fork: Push your changes to your forked repository.

git push origin my-feature-branch

7. Create a Pull Request: Go to the original repository and create a pull request from your forked repository. Provide a clear description of your changes and why they should be merged.

Reporting Issues

If you encounter any issues, please report them using the issue tracker. Provide as much detail as possible to help us resolve the issue quickly.

Thank you for your contributions!

License

This project is licensed under the MIT License. See the LICENSE file for details.