Updated README.md

README.md

@@ -1,19 +1,24 @@
-# Web API Development Front End Demonstration Code
+# Web API Development Front End for Trading License Department
 
-#### Current Status
+### Backend of 6003CEM Module. 
+GitHub -> https://github.coventry.ac.uk/6003CEM-2021JANMAY/Node-Api-BackEnd
+Codio ->  https://animal-hello-3000.codio-box.uk/api/v1/
 
-The repository is currently complete up to the end of the Week 11 worksheet tasks (tag:week11.2). Check out other git tags for known states (see section below).
+### Frontend of 6003CEM Module. 
+GitHub -> https://github.coventry.ac.uk/6003CEM-2021JANMAY/React-JS-FrontEnd
+Codio -> https://chapter-finish-3000.codio-box.uk/
 
 ## About
 
-This repository contains the growing code-base of our example React-based single page web app.
+This repository contains the code-base of a React-based single page web app for a Trading Licence Department, that lets users create their own applications to be accepted or rejected by the admins that can browse all applications.
 
-During the semester we will add to and adjust the default boiler-plate React application set up by the command `create-react-app`. How to use this command will be introduced early in the module.
+## Setup
 
-## Tags / Releases
+To install the required packages navigate to the route folder of the project and run the following command: `npm install`.
 
-Important commits will be tagged so that you can check out a tag and begin working from a known starting point (e.g. what is used in one of the demonstration videos).
+## Running the project
 
-Generally tags will refer to the week the code applies to and will have a description about its state such as _week 2 code after completion of basic worksheet tasks_.
+To run the project navigate to the folder  route folder of the project and run the following command: `npm start`
 
-To see tags in the terminal use `$ git tag -ln1`. In Github the tags appear under the 'release' subtab in the main repository 'code' tab.
+If an error related to memory issues happen, open the package.json file and replace the `start` script value with `react-scripts --max_old_space_size=4096 start`.
+Or instead, it is possible to run the command `export NODE_OPTIONS=--max_old_space_size=4096` prior to running the command: `npm start`.