Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# CodeClash Frontend

We're using a React + TypeScript frontend built with vite.

## Tech Stack

## Tech Stack

| Tool | Purpose |
|------------------|------------------------|
| React | UI framework |
| TypeScript | Type safety |
| Vite | Dev server and bundler |
| React Router DOM | Page routing |

## Installation

- cd frontend
- npm install
- npm install react-router-dom

## Running the App

npm run dev

## Page URL's

The pages are currently using state-based routing, so they are live at the same URL. Navigation is done through the buttons via 'useState'.

## Navigation Flow

- Welcome page
- Sign in → SignIn page
- Sign up → SignUp page
- SignIn page
- ← Back → Welcome page
- Sign up → SignUp page
- SignUp page
- ← Back → Welcome page


## Fonts

"Baloo Bhai 2" font is loaded via Goggle Fonts in each of the CSS files. This requires an internet connection when running.

## Notes

Google and Apple OAuth sign-ins are not implemented yet. The buttons are wired to prop callbacks (`onGoogleSignIn`, `onAppleSignIn`) and is ready for future integration.
2 changes: 1 addition & 1 deletion frontend/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
</html>
Loading
Loading