https://github.com/zgunz42/frontend-repo

https://github.com/zgunz42/frontend-repo

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zgunz42/frontend-repo
• Owner: zgunz42
• Created: 2024-06-24T05:52:44.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-06-26T05:23:58.000Z (4 months ago)
• Last Synced: 2024-06-26T07:39:49.725Z (4 months ago)
• Language: TypeScript
• Size: 151 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Frontend Repository

This repository contains the frontend implementation using Next.js with React MUI for UI components and Redux for state management.

## Directory Structure

```

frontend-repo/

├── apis/

│   └── userApi.ts

├── theme/

│   ├── theme.ts

│   └── ...

├── app/

│   ├── _app.tsx

│   └── ...

├── components/

│   └── UpdateButton.tsx

├── store/

│   ├── reducers.ts

│   └── store.ts

└── package.json

```

## Setup

1. **Install Dependencies**

   ```bash

   npm install

   ```

2. **Firebase Configuration**

   Set up Firebase by creating a `firebaseConfig.ts` file in the root directory with your Firebase project credentials.

3. **Run Locally**

   To run the frontend application locally:

   ```bash

   npm run dev

   ```

## Redux Setup

Redux is used for state management. The store configuration is in `store/store.ts`.

## React MUI Theme

The React MUI theme is defined in `theme/theme.ts`.

## APIs

### `userApi`

- **Description:** Abstraction for backend API calls related to user operations.

- **Location:** `apis/userApi.ts`

## Components

### `UpdateButton`

- **Description:** Button component to trigger backend endpoint for updating data.

- **Location:** `components/UpdateButton.tsx`

## Notes

To test local change `next.config.mjs` in destination variable with right one