Create README.md

How to run the web application on your local computer
A-L-A · Sep 14, 2023 · 38b6734 · 38b6734
1 parent e6a1dee
commit 38b6734
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# Restoz
+
+**How to Run the project locally:**
+
+
+1. Download project as a zip OR clone the repository on you local machine if preferred
+2. Extract files from zip folder 
+3.Open folder with an IDE
+4. Navigate to the folder path in the terminal within your IDE
+4.Initiate a nom repository using “npm init”  in the terminal
+5.Install node modules with “npm i” using the terminal
+6.Run the command “ npm run dev” to start the application with vote on your local server
+
+N.B: When testing out the restaurant locator, it may help to add city names along	 with the country (e.g Port Louis, Mauritius) to generate data due to API limitations. Not all countries have data. 
+