StevenJW/YPS-Beer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
6 Commits 1 Branch 0 Tags 150 KiB
C# 67.6%
Vue 17.5%
TypeScript 13.9%
HTML 0.6%
SCSS 0.4%
master
Go to file
Stedoss bfdf1f96c1 Add info on how to clone
2023-12-07 01:13:47 +00:00
backend Final changes to readmes 2023-12-07 01:12:12 +00:00
frontend Final changes to readmes 2023-12-07 01:12:12 +00:00
.gitignore Initial commit 2023-12-07 00:20:59 +00:00
README.md Add info on how to clone 2023-12-07 01:13:47 +00:00

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:

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!