diff --git a/README.md b/README.md index 3261bd3..b7abad7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ -Environment Variables: +# Poké Poké Guess Weight! +A quick-fire online multiplayer game where users simultaneously guess pokemon's weights. -api/.env +# Installation: +- Clone this github! +- Run `npm i` in the root, frontend and api folders. +- In api folder, add a .env file with the following contents: + `CORS_ALLOWED_URL="http://localhost:5173` + `PORT=3001` + `TIMER=20` +- In the frontend folder, add a .env file with the following contents: + - `VITE_BACKEND_URL="http://localhost:3001"` + +- run `npm run dev` in frontend and api folders. +- visit http://localhost:5173 in your browser -NODE_ENV="development" -JWT_SECRET="secret" -CORS_ALLOWED_URL="http://localhost:5173" -PORT=3001 -TIMER=10 - -frontend/.env - -VITE_BACKEND_URL="http://localhost:3001" +# Tech Used +- Javascript +- NodeJS +- Express +- PokeAPI +- React +- Tailwind