From 44a2db47bc32c1df12899171871ad3f19e7d32e2 Mon Sep 17 00:00:00 2001 From: Mikayla Dobson Date: Sat, 4 Jun 2022 12:56:55 -0500 Subject: [PATCH] readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..09d9e3f --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Socket.io, Express, React + +## Structure +The express server is hosted at root directory level. +Running ``npm install`` here includes the dependencies for Express and Socket.IO server side. + +The ``client`` directory hosts the React front end. +Running ``npm install`` here will install React, Socket.IO client side, as well as Vite tooling and HMR. + +## Run the Project +Run ``npm start`` in the ``client`` directory. +In another terminal, run ``node .`` in the root directory to start the server. \ No newline at end of file