README.md

![](https://github.uconn.edu/clr14003/DMD-4470/blob/master/final/src/assets/slice-o-life-logo-small.png)

# Slice of Life

#### By Clark Reilly


---


## Running a Local Instance

1. Clone the repository.
2. Install Yarn on your computer ([See here for more deatils](https://classic.yarnpkg.com/en/docs/install#windows-stable)).
3. Navigate to the location in which you cloned the repository (the immediate location of the readme, package, and other files).
4. Open Command Prompt.
5. Enter `\cd` into the Command Prompt and hit return.
6. Copy the repository's location (make sure it's in the format `C:\Users\...`).
7. Enter `cd [Paste repository location here, no brackets]` and hit return (make sure to include a space after the `cd`!).
8. (Only necessary the first time) Enter `yarn install` and hit return.
9. Enter `yarn serve` and hit return.
10. Enter the given `localhost` url given into a browser.


---


## Linking Slice of Life to your own database

1. Set up your own [Firebase Database](https://firebase.google.com/docs/database).
2. Within the Firebase console, navigate to the gear icon next to "Project Overview", and select "Project Settings".
3. Navigate to the "Your apps" section, and select the app you wish to connect to Slice of Life.
4. Under "Firebase SDK Snippet", select the "Config" option.
5. Navigate to and open the `.env` within your root directory.
6. Change each of the variables in the `.env` file such that they match the respective information listed under the "Config" section for your own app. **Make sure not to change the variable names themselves, even though they are listed slightly differently.** 
7. Within your Firebase database, start a collection called "posts".