Skip to content

Commit

Permalink
Update README.md and add demo_images
Browse files Browse the repository at this point in the history
  • Loading branch information
nickwu241 committed Apr 5, 2020
1 parent 26fc3b8 commit a9eb3fe
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/
.vscode/

# Flutter/Dart/Pub related
**/doc/api/
Expand Down
51 changes: 49 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,52 @@
# Save The Date

Add events to your calendar from screenshots!
[![YouTube Demo](demo_images/badge-youtube.svg)](https://www.youtube.com/watch?v=pDBKZgbR0xk) [![Devpost](demo_images/badge-devpost.svg)](hhttps://devpost.com/software/save-the-date-dql1fr)

Icons are from [Icons8](https://icons8.com/).
Add events to your calendar just by taking screenshots! Created by [Nick Wu](https://nickwu241.github.io) and Vivian Lam.

**Problem**: When I see a cool event on Instagram/online, it takes a lot of effort to add it into my calendar as a reminder. :(

**Solution**: It's smoother to just take a screenshot and have the event added to your calendar, and that's what we did! ^_^

**How does it work?**

1. User sees an event / message on phone or poster
2. Take a screenshot or photo
3. Share that photo with our app Save The Date
4. Event gets added to your calendar!

![Thumbnail](demo_images/mockups.png)

## Developing

Application code lives in `lib` where `main.dart` is the entry point.

[Install Flutter](https://flutter.dev/docs/get-started/install) if you haven't and you should be able to run our app after!

```bash
flutter run
```

### Directory Structure

```bash
.
├── android # Android specific configurations
├── assets # Static assets (icons, images)
├── ios # iOS specific configurations
├── lib # Application code
│ ├── add_to_calendar.dart # Logic for creating calendar events
│ ├── handle_share_intent.dart # Logic for handling share intents of images from the OS
│ ├── main.dart # Entry point to start the app
│ ├── models.dart # Data models
│ ├── parse_image_file.dart # Logic for parsing out a CalendarEvent from an image
│ ├── parse_text.dart # Helper used in parse_image_file.dart
│ └── widgets # Screens and Reusable Widgets
│ ├── onboarding_widget.dart
│ └── text_detector_painter.dart
└── test # Testing code
```

## Icon Credits

The 3 icons from the onboarding screen are from [Icons8](https://icons8.com/).
2 changes: 1 addition & 1 deletion android/app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
FlutterApplication and put your custom class here. -->
<application
android:name="io.flutter.app.FlutterApplication"
android:label="app"
android:label="SaveDate"
android:icon="@mipmap/launcher_icon">
<activity
android:name=".MainActivity"
Expand Down
1 change: 1 addition & 0 deletions demo_images/badge-devpost.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions demo_images/badge-youtube.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo_images/mockups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo_images/onboard1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo_images/onboard2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo_images/onboard3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo_images/screenshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo_images/thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a9eb3fe

Please sign in to comment.