Skip to content

Commit 18a6470

Browse files
committed
initial release
1 parent 6424ca3 commit 18a6470

96 files changed

Lines changed: 18589 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
node_modules
2+
dist
3+
build
4+
.DS_Store
5+
server/public
6+
vite.config.ts.*
7+
*.tar.gz
8+
build

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Change Log
2+
3+
## [1.0.0] 2025-08-29
4+
5+
### Initial Release

DEPLOYMENT.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# GitHub Pages Deployment Guide
2+
3+
This project is configured for deployment to GitHub Pages using the `gh-pages` package.
4+
5+
## Setup Instructions
6+
7+
1. **Update the homepage URL**:
8+
- Open `package.json`
9+
- Replace `your-username` and `your-repo-name` in the homepage field with your actual GitHub username and repository name:
10+
```json
11+
"homepage": "https://your-username.github.io/your-repo-name"
12+
```
13+
14+
2. **Enable GitHub Pages** (if not already done):
15+
- Go to your GitHub repository
16+
- Navigate to Settings → Pages
17+
- Set Source to "Deploy from a branch"
18+
- Select the `gh-pages` branch (this will be created automatically when you first deploy)
19+
20+
## Deployment Commands
21+
22+
The following scripts are available for deployment:
23+
24+
```bash
25+
# Build the client-side application only
26+
npm run build:client
27+
28+
# Build and deploy to GitHub Pages (runs predeploy automatically)
29+
npm run deploy
30+
31+
# Predeploy script (builds the project before deployment)
32+
npm run predeploy
33+
```
34+
35+
## Deployment Process
36+
37+
1. **Make your changes** and commit them to your main branch
38+
2. **Deploy to GitHub Pages**:
39+
```bash
40+
npm run deploy
41+
```
42+
43+
This will:
44+
- Run the `predeploy` script which builds the client application
45+
- Deploy the `build` directory contents to the `gh-pages` branch
46+
- Your site will be available at the URL specified in the homepage field
47+
48+
## Important Notes
49+
50+
- Only the client-side React application is deployed to GitHub Pages
51+
- The server components are not deployed (GitHub Pages only serves static files)
52+
- The `build` directory is excluded from version control via `.gitignore`
53+
- Make sure to update the homepage URL in `package.json` before deploying
54+
55+
## Troubleshooting
56+
57+
If deployment fails:
58+
1. Ensure you have the correct repository permissions
59+
2. Verify the homepage URL is correct
60+
3. Check that GitHub Pages is enabled in repository settings
61+
4. Make sure the `gh-pages` branch exists and is set as the Pages source

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Creative Tim (https://www.creative-tim.com)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
633 KB
Loading
787 KB
Loading
156 KB
Loading
43.1 KB
Loading
339 KB
Loading

client/index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1" />
6+
</head>
7+
<body>
8+
<div id="root"></div>
9+
<script type="module" src="/src/main.tsx"></script>
10+
<!-- This is a replit script which adds a banner on the top of the page when opened in development mode outside the replit environment -->
11+
<script type="text/javascript" src="https://replit.com/public/js/replit-dev-banner.js"></script>
12+
</body>
13+
</html>

0 commit comments

Comments
 (0)