YPS-Beer/README.md

# YPS Beer

## Development and Running
To view the steps to run the application, please visit the `frontend` and `backend` directories respectively.

To clone the repo, run:
```sh
git clone http://git.stevenjw.co.uk:3000/StevenJW/YPS-Beer.git
```

> NOTE: SSH cloning will not work.

## How to use the application
Upon running both services, opening the frontend application at `http://localhost:3000` will show a login screen.

You will need to create an account, which can be done by clicking on the `Sign up now` button on the login form. Once you've created an account, it will redirect you to the login screen where you can login with the credentials you just entered.

You can then freely use the app!

## Feedback
I found this task to actually be quite challenging due to the inclusion of authentication - I have only used 3rd party services to integrate auth, mainly Auth0 and NextAuth. So, this was quite new for me and I did run into some pitfalls.

Please, do feel free to provide as much feedback as possible for me also on this!
Initial commit 2023-12-07 00:20:59 +00:00			`# YPS Beer`

			`## Development and Running`
			To view the steps to run the application, please visit the `frontend` and `backend` directories respectively.

Add info on how to clone 2023-12-07 01:13:32 +00:00			`To clone the repo, run:`
			```sh
			`git clone http://git.stevenjw.co.uk:3000/StevenJW/YPS-Beer.git`
			```

			`> NOTE: SSH cloning will not work.`

Initial commit 2023-12-07 00:20:59 +00:00			`## How to use the application`
			Upon running both services, opening the frontend application at `http://localhost:3000` will show a login screen.

			You will need to create an account, which can be done by clicking on the `Sign up now` button on the login form. Once you've created an account, it will redirect you to the login screen where you can login with the credentials you just entered.

			`You can then freely use the app!`

			`## Feedback`
			`I found this task to actually be quite challenging due to the inclusion of authentication - I have only used 3rd party services to integrate auth, mainly Auth0 and NextAuth. So, this was quite new for me and I did run into some pitfalls.`

			`Please, do feel free to provide as much feedback as possible for me also on this!`