Giter VIP home page Giter VIP logo

revision's Introduction

Revision

This repository contains all source code and dependencies for Revision.

A collaborative resume critiquing platform which allows users to upload & share their resume for feedback as well as provide suggestions for others. Simply either log in or register, upload your resume in PDF format, and share your link with others.

Revision Demonstration

What it Features

User Authentication

When first navigating to the page, it will inform the user to either log in or register as a new user. After creating an account and successfully logs in, a JWT token will be generated for the user's session which will allow the user to access the application and it's features.

Uploading Documents

Users are able to upload a PDF document, giving a document name and description of their choice. After it is uploaded, it will show up in their list of documents.

Viewing Documents

From the home page, users can navigate to the list of documents that belong to them to view the document and associated comments.

Sharing Documents

After uploading their document, users can send their document link to peers. This allows others to view the document and comment their suggestions and feedback.

How I Built it

The frontend of the project is built using React.js and Redux, consisting of while the backend consists of Node.js, Express.js, MongoDB, and AWS S3. It is currently deployed on Heroku.

Inspiration

This project was inspired by an issue I continously ran into when I was helping others edit their resume or having others edit mine. With Google Drive not really optimized for leaving comments on uploaded PDF documents, I often found myself having to send screenshots of my resume through Messenger to others. I wanted to make an application where people are easily able to upload & share different versions of their resume and be able to see all their comments in one place. It was a cool project that allowed me to solve an issue that I was having personally while learning more about the technologies I was curious about learning more in!

What's Next

  • Integrate Google sign in so people can log in with their google account.
  • Improve commenting feature by allowing users to highlight and annotate PDF.
  • Add ability to select explictly who you want to share your document with.
  • Enhance user home page by also displaying the documents that others have shared with you.

Local Development Instructions

Server

After downloading the dependencies, start the server by: npm run start

Client

Navigate to the client directory and install the dependencies. Then, run the command: npm run start

revision's People

Contributors

feng-eric avatar

Stargazers

Max Zhou avatar Tyler Pinto avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.