From 5f0d82b921e5c02b5f5a58915929c93b77d6ee6b Mon Sep 17 00:00:00 2001
From: Ashwanth K <cb.en.u4cse19305@cb.students.amrita.edu>
Date: Sun, 27 Dec 2020 20:37:52 +0530
Subject: [PATCH] Update README.md

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96dd296..81ba620 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,40 @@
 # Book-Management-System
 
-A Book-Management-System web appliction created using MERN stack
\ No newline at end of file
+A Book-Management-System web appliction created using MERN stack
+
+run 'npm init' in main directory and client directory to get node modules
+run 'npm install mongoose cors axios react-router-dom express nodemon bootstrap'
+
+To start: cd client , npm run start
+To build:  cd client , npm run build
+
+Description:
+ This web app is created using MERN-stack
+ ie, MongoDB,Express,React(FRONT-END),NodeJs.
+
+ Axios is used to make http: post,get and delete requests.
+ Mongoose and cors were used.
+ Mongodb atlas is used for this web app.
+
+BACKEND:(MongoDB, NodeJs)
+
+ Parent folder BMS-MERN has models for data to be inserted in the database and routes for making http: post,get and delete requests.
+ .env file has the environment variable of URI for Mongodb Atlas
+ Server.js is the main server file which specifies the ports and routes for the backend.
+
+FRONTEND(React Js)
+
+In the BMS-MERN folder a simple react app was created using 'npx create-react-app client'
+
+Index.html lies in public directory which renders the info sent by index.js in src folder.
+index.js takes info from App.js where we created several routes for different pages(made of components and child components)
+Component folder inside client holds all components rendered by App.
+
+Inside component folder:
+  1]index component in Components folder is the main page component
+  2]Admin folder has Admin-login component and Admin-home component.
+  3]Student folder has Student-login component and Student-home component.
+  4]Forms has all the form components required for adding,removing and updating books and users
+  It also has the search components for books,users and borrowers.
+  5]About folder has about component and related images.
+  6]navbar is the navigation bar component.
-- 
GitLab