File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -71,6 +71,41 @@ npm run build
7171npm run preview
7272```
7373
74+ ## Deploying to GitHub Pages
75+
76+ This project is configured to deploy to GitHub Pages automatically.
77+
78+ ### Setup (one-time)
79+
80+ 1 . Push your code to GitHub
81+ 2 . Go to your repository ** Settings** → ** Pages**
82+ 3 . Under ** Build and deployment** , set ** Source** to ** GitHub Actions**
83+
84+ ### Automatic Deployment
85+
86+ Once configured, every push to ` main ` will automatically:
87+ 1 . Build the project
88+ 2 . Deploy to GitHub Pages
89+
90+ Your site will be available at: ` https://<username>.github.io/MWD-API-Explorer/ `
91+
92+ ### Manual Deployment
93+
94+ To deploy manually:
95+
96+ ``` bash
97+ # Build the project
98+ npm run build
99+
100+ # The dist/ folder contains the built site
101+ ```
102+
103+ Then push the ` dist/ ` contents to a ` gh-pages ` branch, or use the GitHub Actions workflow included in ` .github/workflows/deploy.yml ` .
104+
105+ ### Important Note
106+
107+ The ` base ` path in ` vite.config.ts ` is set to ` /MWD-API-Explorer/ ` . If your repository has a different name, update this value to match.
108+
74109## License
75110
76111This project is open source. The data displayed is public information provided by MWD.
Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ import path from 'path'
44
55export default defineConfig ( {
66 plugins : [ react ( ) ] ,
7- base : '/MWD-API-Explorer /' ,
7+ base : '/mwd-wins-api-explorer /' ,
88 resolve : {
99 alias : {
1010 '@' : path . resolve ( __dirname , './src' ) ,
You can’t perform that action at this time.
0 commit comments