@felvin-search/apps

Felvin Search

Your search box is now an app store! 🎉 - Felvin

How to use?

felvin.com

What are instant apps?

Instant apps are the small interactive cards which you get for your search queries.

We can build instant apps for all kinds of use cases like dictionary, checking football scores, stock prices or notes from your notion or even search history from company slack or anything!

Try them out live - felvin.com

Contributing

There are many ways in which you can contribute to the project

• Try creating a new app, it's fun and it's a new kind of superpower. 😎
• Take a look at existing suggestions of new apps and implement one!
• Suggest a new instant app, anything useful for you is a valid suggestion.
• Add features to existing apps. See all open issues.

How to create a new app?

Anyone can create an instant app! Felvin Search is a platform - create apps for yourself, as well as others.

• Fork the repository
• Run yarn create-app.
• Update your new app, commit and send a pull request!

Checkout our CONTRIBUTING guide for more details.

Anatomy of Instant App

A instant app is a Javascript object with following schema:

• name
• description
• queryToData: A function which takes a search query and converts into any data which could be displayed.
• Component: The React component of the app. The data from queryToData is passed as a prop.

Read more about the architecture.

Available Apps

See src/apps/.

How do releases take place?

All the instant apps are published to npm registry here. Currently, we have an action setup which bumps up the package version, commits the tag and publishes the release.

These are minor releases i.e. v0.3.0 -> v0.4.0

Community

• Discord chatroom - Join us on Discord to engage.
• Give us a star ⭐️ - if you appreciate what we are doing, we would love a star on GitHub ❤️