Skip to content

Commit f220603

Browse files
committed
Add Help & FAQ button to navigation and update README with live demo link
1 parent 477f14e commit f220603

2 files changed

Lines changed: 57 additions & 21 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,40 +48,44 @@ Resume Author is part of the **T3 Innovation Network** initiative, designed to c
4848
### Installation
4949

5050
1. **Clone the repository**
51+
5152
```bash
5253
git clone https://github.com/your-org/resume-author.git
5354
cd resume-author
5455
```
5556

5657
2. **Install dependencies**
58+
5759
```bash
5860
npm install
5961
# or
6062
yarn install
6163
```
6264

6365
3. **Environment Configuration**
64-
66+
6567
Create a `.env` file in the root directory with the following variables:
68+
6669
```env
6770
# Google OAuth
6871
REACT_APP_GOOGLE_CLIENT_ID=your_google_client_id
6972
REACT_APP_GOOGLE_REDIRECT_URI=http://localhost:3000/auth/callback
70-
73+
7174
# Auth0 Configuration
7275
REACT_APP_AUTH0_DOMAIN=your_auth0_domain
7376
REACT_APP_AUTH0_CLIENT_ID=your_auth0_client_id
74-
77+
7578
# Backend Server
7679
REACT_APP_SERVER_URL=https://linkedcreds.allskillscount.org
77-
80+
7881
# Firebase Configuration
7982
REACT_APP_FIREBASE_API_KEY=your_firebase_api_key
8083
REACT_APP_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
8184
REACT_APP_FIREBASE_PROJECT_ID=your_project_id
8285
```
8386

8487
4. **Start the development server**
88+
8589
```bash
8690
npm start
8791
# or
@@ -202,14 +206,15 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
202206

203207
## 📞 Support
204208

205-
- **Live Demo**: [https://resume-author.vercel.app/](https://resume-author.vercel.app/)
209+
- **Live Demo**: [https://resume.allskillscount.org/](https://resume.allskillscount.org/)
206210
- **Documentation**: Check the `/docs` folder for detailed documentation
207211
- **Issues**: Report bugs and feature requests in the GitHub Issues section
208212
- **FAQ**: Visit `/faq` route in the application for frequently asked questions
209213

210214
## 🔄 Changelog
211215

212216
### Version 0.1.0
217+
213218
- Initial release with core resume editing functionality
214219
- Google Drive integration for storage
215220
- Verifiable credentials support
@@ -221,4 +226,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
221226

222227
**Built with ❤️ by the T3 Innovation Network team**
223228

224-
*Empowering individuals to showcase their skills and experiences securely in the digital age.*
229+
_Empowering individuals to showcase their skills and experiences securely in the digital age._

src/components/Nav.tsx

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,31 @@ const Nav = () => {
147147
</IconButton>
148148
</Box>
149149
<List>
150+
{/* Always show Help & FAQ */}
151+
<ListItem disablePadding>
152+
<Button
153+
fullWidth
154+
onClick={() => {
155+
navigate('/faq')
156+
setMobileMenuOpen(false)
157+
}}
158+
sx={mobileNavStyles}
159+
>
160+
Help & FAQ
161+
</Button>
162+
</ListItem>
163+
150164
{!isLogged ? (
151165
<>
152-
{navItems.map((item, index) => (
153-
<ListItem key={index} disablePadding>
154-
<Button fullWidth onClick={item.action} sx={mobileNavStyles}>
155-
{item.label}
156-
</Button>
157-
</ListItem>
158-
))}
166+
{navItems
167+
.filter(item => item.label !== 'Help & FAQ')
168+
.map((item, index) => (
169+
<ListItem key={index} disablePadding>
170+
<Button fullWidth onClick={item.action} sx={mobileNavStyles}>
171+
{item.label}
172+
</Button>
173+
</ListItem>
174+
))}
159175
<ListItem disablePadding>
160176
<Button fullWidth onClick={handleLogin} sx={mobileNavStyles}>
161177
Login
@@ -174,19 +190,34 @@ const Nav = () => {
174190
</>
175191
) : !isLogged ? (
176192
<Stack direction='row' spacing={{ sm: 2, md: 5 }}>
177-
{navItems.map((item, index) => (
178-
<Button key={index} color='inherit' sx={navStyles} onClick={item.action}>
179-
{item.label}
180-
</Button>
181-
))}
193+
{navItems
194+
.filter(item => item.label !== 'Help & FAQ')
195+
.map((item, index) => (
196+
<Button
197+
key={index}
198+
color='inherit'
199+
sx={navStyles}
200+
onClick={item.action}
201+
>
202+
{item.label}
203+
</Button>
204+
))}
205+
<Button color='inherit' sx={navStyles} onClick={() => navigate('/faq')}>
206+
Help & FAQ
207+
</Button>
182208
<Button onClick={handleLogin} color='inherit' sx={navStyles}>
183209
Login
184210
</Button>
185211
</Stack>
186212
) : (
187-
<Button onClick={handleLogout} color='inherit' sx={navStyles}>
188-
Logout
189-
</Button>
213+
<Stack direction='row' spacing={{ sm: 2, md: 5 }}>
214+
<Button color='inherit' sx={navStyles} onClick={() => navigate('/faq')}>
215+
Help & FAQ
216+
</Button>
217+
<Button onClick={handleLogout} color='inherit' sx={navStyles}>
218+
Logout
219+
</Button>
220+
</Stack>
190221
)}
191222
</Toolbar>
192223
</AppBar>

0 commit comments

Comments
 (0)