Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 2.8 KB

README.md

File metadata and controls

77 lines (52 loc) · 2.8 KB

Best Surprise

Logo

MIT License PR's Welcome Issues

Send letters and postcards to individuals or a large number of contacts, in one simple step. No setup required – be up and running in minutes.

How is this tool helpful?

  • Express yourself: Pour your heart out onto the digital piece of paper
  • Instant Delivery: Your letter is delivered by just sharing the url! Easy and simple.

Technology Stack

Languages

  • Javascript
  • Node.js
  • MongoDB
  • HTML5/ CSS3

Getting Started

File Structure

Directory Content
models contains the database models
routes contains routing modules
views contains all frontend components

Setup

  • Fork and clone the repo
$ git clone https://github.com/vrushti-mody/Best-Surprise.git
$ cd Best-Surprise
  • Install dependencies
$ npm install
  • Add the .env file
MONGODB_URI = <YOUR MONGODB URI>
  • Run the server
$ npm start

Contribution Guidelines

PR's Welcome Contributors

If you have suggestions for how Best Surprise could be improved, or want to report a bug, open an issue! Contributions of all kinds are welcomed!

For more, check out the Contributing Guide.

Live Demo

If you want to try out our application, visit https://best-surprise.herokuapp.com

Video Demo

If you want to watch how the application works, visit https://www.youtube.com/watch?v=Di4liJflCoQ&t=7s

License

MIT © 2020 WandaVision

Made with 💕 by Vrushti Mody and Rohan Poojari for the Surprise Hacks Hackathon!