As a user, I should see a summary of the project when I open the repository on Github.
AC
WHEN I open this project on Github
THEN I should see a summarization of the project, technologies used, contributors, instructions for pulling down the project to view it
AND I should see screenshots of the project deployed.
Dev Notes
Open the readme.MD file -- use markdown syntax to edit the following
Edit the Description section and briefly sum up the entire project in a few small paragraphs
Edit the Technologies Used section and create a list of all technologies used to complete this project -- for example, HTML5, Bootstrap, Moment.js, etc
Edit the Screenshots section and add descriptions for each screenshot added for neatness
Edit the Run this Project section with the following instructions
Clone down project from Github
Add apiKeys from Firebase formatted identically to the apiKeysExample.json file
At the root, run the command npm start
This should automatically redirect you to the local host, but if not, run hs -p 8080, and in your browser, navigate to https://localost:8080
Update the Contributors section that lists all new contributors and makes their name a hyperlink to each person's Github profile
User Story
As a user, I should see a summary of the project when I open the repository on Github.
AC
WHEN I open this project on Github THEN I should see a summarization of the project, technologies used, contributors, instructions for pulling down the project to view it AND I should see screenshots of the project deployed.
Dev Notes
readme.MD
file -- use markdown syntax to edit the followingDescription
section and briefly sum up the entire project in a few small paragraphsTechnologies Used
section and create a list of all technologies used to complete this project -- for example, HTML5, Bootstrap, Moment.js, etcScreenshots
section and add descriptions for each screenshot added for neatnessRun this Project
section with the following instructionsnpm start
hs -p 8080
, and in your browser, navigate to https://localost:8080Contributors
section that lists all new contributors and makes their name a hyperlink to each person's Github profile