Skip to content

teafor-me/teafor.me

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 

Repository files navigation


teaforme icon

teafor.me

the new way to browse tea

About

screenshot of teafor.me

teafor.me makes browsing quality tea from your favorite vendors lightning fast, fun, and effortless. Easily sort and filter products by whatever matters most to you, from type to vendor to price. Use the search to find exactly what you’re looking for, or shuffle the products to discover something new. teafor.me’s lightweight responsive user interface shows you everything you need to know about a product at a glance, no matter what device you use. With thousands of products from leading vendors and data updated daily, teafor.me streamlines exploring quality premium tea like never before.

teafor.me is a non-commercial passion project developed and maintained for the benefit of the tea community. Its creation was motivated by a personal desire to make finding great tea simple, no matter your location, taste or budget by cooperating with highly reputable vendors of (mostly) unflavored tea from around the world.

Built with

Typescript Next React Firebase Node.js Puppeteer Google Cloud Platform Sass Framer Motion GraphQL

(back to top)

Contributing

teafor.me was created for the tea community, and we’re always aiming to improve how it meets the community’s needs. Contributions by members of the community are encouraged!

Unfortunately, fully open-sourcing teafor.me is not possible for the time being. It’s important to protect the intellectual property of the vendors with whom teafor.me is partnered. If made public, much of teafor.me’s code could enable bad actors to misuse data or intellectual property that should only be used with the express permission of vendors. In addition to the demo code in this repository, contributors may be given private access to certain parts of teafor.me‘s code to the extent required for their contribution. Furthermore, frontend contributions submitted via pull requests will be public.

Please note that contributions are subject to teafor.me's terms of use.

(back to top)

Help add a vendor to teafor.me

(If you are associated with a vendor and would like to request that your products be added to teafor.me, please contact copyright@teafor.me.)

Is there a premium tea vendor you’d like to see added to teafor.me? We’re always open to consider expanding teafor.me’s catalog.

Start by opening an issue using the Vendor Request template. In order to maintain a high standard of quality and trustworthiness on teafor.me, vendor requests need to be accompanied by proof of community support and must receive admin approval before being processed. Once a requested vendor is approved, please email the vendor to ask for their permission to display their products on teafor.me and CC copyright@teafor.me. You are welcome to use the email template in this repository to do so. Once permission is granted, you can start working to integrate the vendor’s products. The process depends on the type of online shop the vendor has:

  • For vendors using Shopify, no additional steps are required on your part.
  • For vendors using other e-commerce platforms (such as BigCommerce, WooCommerce, or Spree Commerce), please contact teafor.me’s admin to determine what steps need to be taken depending on the specific platform.
  • For vendors not using any e-commerce platform, it may be necessary to use Puppeteer to scrape product data. You can find an example here. If it is decided that the data from the requested vendor needs to be scraped, please use this template.

Due to intellectual property and privacy concerns, please do not submit code related to vendor requests via pull requests! Instead, push your code to a new repository. If you create a private repository (preferable), add @jhyahav as a collaborator. Otherwise, send a link to your repository to contribute@teafor.me.

(back to top)

Contribute to the frontend by creating a React component or a Next.js page

Do you think teafor.me's frontend is missing something? New pages and components that expand what teafor.me has to offer are always welcome.

Start by opening an issue using the Feature Request template describing what you'd like to add, and make sure to state that you'll be able to implement it. Please note that not all pages and components can be added to teafor.me for various reasons, so it's best to wait for confirmation that your page/component can be added before starting work on it.

To contribute to the frontend, fork this repository and add your custom page(s) or component(s) in the templates/frontend folder, then submit your code via a pull request. Please stick to TSX and try to keep the number of dependencies beyond those already in package.json to a minimum. If your contribution includes new styles, please add them as a Sass module in the styles folder.

If you need access to parts of teafor.me's frontend code for your contribution, make sure to mention this in your feature request and to be in touch with teafor.me's administrator.

(back to top)

Help with new features

If you’d like to help add features (preferably ones you can help implement), you can open a feature request issue to suggest a new one. You can also offer your assistance in adding features suggested by other community members under the help wanted tag.

(back to top)

Report and help solve bugs

If you encounter a bug or an error while using teafor.me, it would be very helpful if you could report it. You can do this by opening an issue using the Bug Report template. Please provide as much information as you can. Additional input on unsolved bugs, be it adding information to existing reports or suggesting possible solutions, is also appreciated, as is your help with bugs tagged help wanted.

(back to top)

If you are interested in contributing to teafor.me in a way that is not listed above, please contact contribute@teafor.me.

(back to top)

Contact

Please see teafor.me's contact page for general contact information. For inquiries related to contributions, please email contribute@teafor.me.

(back to top)

About

Public contribution repo for teafor.me, the new way to browse tea

Resources

Stars

Watchers

Forks

Releases

No releases published