diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..623d1ea --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# event-me + +All the events you never knew you needed to attend! + + +## Overview + +This is a simple full-stack web project for educational purposes, to demonstrate the functionality and value of moving from JS to TS gradually. + +## Installation + +Make sure you have an up-to-date version of [Node](https://nodejs.org/en/download) installed, including [npm] + + + +``` +cd backend +npm i +cd ../frontend +npm i +``` + +## Running in development + +Run the backend and frontend in separate terminals. + +1) Run the backend API + +Install backend dependencies and launch the dev server: + +``` +cd backend +npm i +npm run dev +``` + +The API will be available at `http://localhost:3000/api`. + +Leave the backend running in this terminal. + +3) Run the frontend client + +In a _new_ terminal, install frontend dependencies and launch the dev server: + + +``` +cd frontend +npm i +npm run dev +``` + +Open the app at `http://localhost:5173`. + +Leave the frontend running in this terminal. + |