Peruse Code

Peruse Code makes it easy to read code online so you can write better code!

Comment

Inspiration

“Indeed, the ratio of time spent reading versus writing is well over 10 to 1. We are constantly reading old code as part of the effort to write new code. ...[Therefore,] making it easy to read makes it easier to write.”

― Robert C. Martin, Clean Code: A Handbook of Agile Software Craftsmanship

Whether it was internal code reviews, trying to understand the code from a tutorial about that shiny new framework you wanna learn or simply just to peek under the hood of your favorite open source project. We as developers spend a huge chunk of time reading code and a lot of this code is stored and hosted on Github.

Peruse Code makes it easy to read code online so you can write better code!

What it does

Peruse Code - turns your favorite Github reposistory into a easy to navigate code editor online

Peruse Code comes with a nifty note feature that allows you to annotate individual files and add additional comments, input and feedback.

You can also save your favorite repos and access them from either your computer or on the go using your mobile phone.

We've also written a chrome extension that simplifies viewing repos and saving them on the fly in your browser!

Check it out: Install Peruse Code Chrome Plugin

How we built it

Frontend - our frontend is written entirely React and a service worker to allow for PWA functionality - so you can install the app in your home screen and use it as a mobile or desktop app.

The backend is a microservices architecture built with Serverless, mostly node and sprinkles of python code. We use DynamoDB to store data - we choose this because of the scalability and low latency it offers.

Use the public workspace to test the API and how we use Github: View Our Workspace

Challenges we ran into

We had so many more ideas and features we  wanted to pack into our initial release but with the limited time of the hackathon we had to streamline our feature roadmap.

Accomplishments that we're proud of

  • We put together a really good workspace on Postman
  • We put together a good initial release - just in time!
  • Our chrome plugin got approved as well
  • We became users of our own product at least

What we learned

We had to learn a lot about the Github API, It's authentication methods and we used Postman a lot for API discovery and testing before writing any code.

What's next for Peruse Code

We have a list of features we wanna add in the next release - we've also created a project roadmap that we intent to follow but feedback from people might help us shape the app to be useful to more than just us!

Share this project:

Updates