MJ Css frameworks

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 .DS_Store
 dist/
+

README.md

@@ -1,2 +1,64 @@
-# css-frameworks-ca
-Replace this text with a description of your social media project.
+# FlashGrid - css-frameworks-ca
+
+[![FlashGrid Screenshot](resources/readme-img/flashgrid-readme-img.jpg)](https://flashgrid-ca.netlify.app/)
+
+Goal: To apply knowledge of Bootstrap and SASS to build a responsive front end for a social media application.
+
+## Description - Assignment brief:
+
+You are tasked with creating 3 pages in HTML using Bootstrap and SASS:
+
+Authentication page (/index.html)
+Feed Page (/feed/index.html)
+Profile page (/profile/index.html)
+The authentication page should have a form to login or register to the application. Ensure to include HTML form validation and use /profile as the action attribute. Password must have a minimum length of 8 characters.
+
+The feed page should have a list of posts thumbnails, a search bar, sort options and a form to create a new post. You may add additional design features beyond these requirements.
+
+The profile page should have a profile image, username, list of user posts, follow button and an area to display following/followers.
+
+There is no requirment for JS functionality beyond Bootstrap UX behaviour. For example, using the provided dropdowns, tabs or carousel is acceptable but there is no further requirement for custom JS.
+
+Submission for this project will follow the pattern used in professional development. You are expected to seek feedback from your peers to complete this assignment. When requesting feedback it is useful to ask for a specific area to be reviewed in order to get the most out of your feedback.
+
+**The site consists of the following pages:**
+
+- Authentication page
+- Profile page
+- Feed page
+
+## Tech stack used in this project:
+
+[![My Skills](https://skillicons.dev/icons?i=bootstrap,sass,html,figma,js)](https://skillicons.dev)
+
+## Getting Started
+
+### Installing
+
+1. Clone the repo:
+
+```bash
+git clone https://github.com/mjohank/css-frameworks-ca/tree/css-frameworks
+```
+
+2. Install the dependencies (make sure you have Node installed):
+
+```
+npm install
+```
+
+### Running
+
+3.To run the app, run the following commands:
+
+```bash
+npm run build
+```
+
+## Contact me
+
+Email: [mjohandev@gmail.com](mailto:mjohandev@gmail.com)
+
+## Link to live site:
+
+https://flashgrid-ca.netlify.app/