---
# System prepended metadata

title: Project Name

---

# Project Name

![Team Photo](Insert a Team Photo URL here)
[*how?*](https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files)

Description:
[Name of product] gives users a platform to vent their feelings, express their emotions and find a supportive community via writing - all while retaining your anonymity. Whether you want to reflect on your past notes or never see them again, this app is for you.

TODO: screenshots

## Architecture

Tools Used:
* React.js
* Express
* Mongo
* Heroku

Libraries Used:
* Google ML Kit from Firebase
* Potentially Spotify API

Organization:
* Feature based file structure

Example:
* src/
    * assets
    * actions
    * reducers
    * containers
        * FEED
            * components
            * style.scss
        * NEW POST
            * components
            * style.scss
        * PROFILE
            * components
                * SETTINGS
            * style.scss
    * shared components
        * Post.js
        * Post.scss 
        * Posts.js
        * Posts.scss
* server
    * TODO


## Setup

* Basic set up from starter pack
* Yarn
* TODO: add libraries

## Deployment

* Heroku

## Authors

* Alaina Arnold
* Daniel Diaz
* Kai Frey - Tags / Google ML Kit
* Max Lata - Backend 
* Katie Huang 
* Vivian Tran - Design

## Acknowledgments
Us :) 

### Front-End Views/Routes
* Homepage (user feed)
* Blank "make a post" page
* Profile/Post collection (if wanted)
* Make new post
* Settings (may not be its own route)

### Back-End
Models:
* User
    * UUID
    * Username
    * Email
    * Password
    * Profile Picture
    * Settings
        * Completely private / completely public / visible to only you
        * Color theme
        * Followed tags
    * Blocked users
* Post
    * Title
    * Poster
    * Interactions
        * Thumbs Up
        * Heart
        * Encourage
    * Timestamp
    * Tags
    * Content
    * Want comments / don't want comments
    * Comments