Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

kevinjosethomas/turbo

Repository files navigation

Turbo

The browser for developers.

Turbo is built with Electron and React, this makes it an embedded Chrome application. In simpler terms, it packs the power and some of the security that comes with Google Chrome but it doesn't have any of the data tracking and privacy breaches that Chrome comes with. All parsing of a website's HTML and CSS is done by Electron (embedded Chrome) but we add what makes Turbo the browser for developers. Turbo comes with a bunch of features from an integrated API client (like Postman) and localhost to public port tunneling (like ngrok) to easily customizable themes and a fully keyboard navigationable interface. We're currently working on Turbo and it's in a closed beta stage! If you want to get early access, sign up on our waitlist and check our website out!

Opensource & Building in public

Turbo is completely opensource and we're building it in public on Twitter and Discord. What does this mean?

According to @heyblake, building in public means sharing -

  • Wins
  • Losses
  • Strategy
  • Processes
  • Behind the scenes
  • Documentation
  • Resources
  • Methods
  • Systems
  • Updates
  • Ideas
  • Fears
  • Tools

This is basically the same attitude we take towards Turbo's opensource and building in public status. Although we're pretty new to this, we want Turbo development to be as transparent and inclusive as possible!

Contributing

Thanks for your interest in contributing! 🎉 You can contribute by reporting bugs, suggesting features and by developing and resolving existing issues! If you're looking to contribute, read our code of conduct, contributing guidelines and you should know what to do! Contact us in our support Discord server if you have anymore questions!

If you're interested in contributing with bugs or feature requests, either -

  • create a new issue
  • choose the respective issue template (bug report of feature request)
  • follow the template and describe the issue
  • create the issue and wait for a maintainer to review it or you can report it in our Discord server

If you are interested in contributing with code, you need to -

  • find an issue with the help wanted tag
  • comment on the issue and ask for a maintainer to assign you to it
  • once the issue has been assigned, create a fork of this repository's staging branch
  • make your desired changes
  • create a new PR from your fork to Turbo's staging branch (follow the PR template we provide)
  • wait for a maintainer to review your PR

If you're making a Turbo fork or clone, make sure you read through our license. We do not appreciate people publishing clones of Turbo, and abusing it's opensource status.

Development

Here's a guide on running Turbo locally. If you're on a local fork of Turbo, make sure you are on the staging branch.

Running developmnt server

  • run npm install to install all our dependencies
  • run npm run start to start our frontend
  • wait till it opens a chrome tab at localhost:3000, close the tab and run npm run dev
  • it should open a new window with Turbo!

Conclusion

Thanks a lot for reading through! Star this repository, check out our website, join our Discord server and follow us on Twitter! Have a nice day! ✌