README.md updated

README.md

@@ -1,2 +1,63 @@
-ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'java1234!';
+# Target
 
+## Automatic NBA CO Attainment Calculator 
+
+Calculation of termwork, internal scores and attainment is one of the more essential parts of the working of any institute. Trying to automate this process is what our project focuses on. We have created an extremely intuitive portal which makes it easier for the staff members to communicate with their respective subject heads and keep a track of individual student assessment. We used MySQL as the database backend along with NodeJS and ExpressJS. React was used to make a clean interface.
+
+## Prequisites on the local machine to project to be run:
+
+1. Node JS v12.x or above 
+2. Yarn v1.22.x or npm v6.x or above
+
+## Steps to run the project on the local machine
+
+1. Clone this repository into your local machine by using<br> 
+    `git clone https://github.com/tanmaypardeshi/Target.git`
+
+* ### Setting up the node.js local server:
+
+1. cd into the <i>backend</i> directory.
+2. Use command **yarn** to install node modules for the front end.
+3. Once the node modules have been installed, run **yarn start** to start the development server.
+
+* ### Setting up the react local server:
+
+1. cd into the <i>frontend</i> directory.
+2. Use command **yarn** to install node modules for the front end.
+3. Keep the node server up and running to make the website functional.
+4. Once the node modules have been installed, run **yarn start** to start the development server.
+
+## Snippets of the platform : 
+
+
+**Login and registration:**
+
+<p float="left">
+    <img src="screenshots/1.PNG" alt="1.PNG" width="700" height="300">
+    <img src="screenshots/2.PNG" alt="2.PNG" width="700" height="300">
+</p>
+
+**Admin Interface:**
+<p float="left">
+    <img src="screenshots/3.PNG" alt="3.PNG" width="700" height="300">
+    <img src="screenshots/4.PNG" alt="4.PNG" width="700" height="300">
+</p>
+
+<p float="left">
+    <img src="screenshots/5.PNG" alt="5.PNG" width="700" height="300">
+    <img src="screenshots/6.PNG" alt="6.PNG" width="700" height="300">
+</p>
+
+**Teacher Interface:**
+
+<p float="left">
+    <img src="screenshots/7.PNG" alt="7.PNG" width="700" height="300">
+    <img src="screenshots/8.PNG" alt="8.PNG" width="700" height="300">
+</p>
+
+**Coordinator Interface:**
+
+<p float="left">
+    <img src="screenshots/9.PNG" alt="9.PNG" width="700" height="300">
+    <img src="screenshots/10.PNG" alt="10.PNG" width="700" height="300">
+</p>