|
2 | 2 |
|
3 | 3 | An interactive web application for visualizing and exploring optimization algorithms developed by Prof. R.V. Rao. |
4 | 4 |
|
| 5 | +## Live Demo |
| 6 | + |
| 7 | +**[Visit the live application](https://vaidhyamegha.github.io/optimization_algorithms/)** |
| 8 | + |
5 | 9 | ## Overview |
6 | 10 |
|
7 | 11 | This frontend application provides a comprehensive visualization platform for understanding and comparing various optimization algorithms: |
@@ -49,27 +53,41 @@ frontend/ |
49 | 53 |
|
50 | 54 | ### Installation |
51 | 55 |
|
52 | | -1. Clone the repository: |
53 | | - ```bash |
54 | | - git clone https://github.com/VaidhyaMegha/optimization_algorithms.git |
55 | | - cd optimization_algorithms/frontend |
56 | | - ``` |
57 | | - |
58 | | -2. Install dependencies: |
59 | | - ```bash |
60 | | - npm install |
61 | | - # or |
62 | | - yarn install |
63 | | - ``` |
64 | | - |
65 | | -3. Start the development server: |
66 | | - ```bash |
67 | | - npm start |
68 | | - # or |
69 | | - yarn start |
70 | | - ``` |
71 | | - |
72 | | -4. Open [http://localhost:3000](http://localhost:3000) to view the application in your browser. |
| 56 | +```bash |
| 57 | +# Clone the repository |
| 58 | +git clone https://github.com/VaidhyaMegha/optimization_algorithms.git |
| 59 | + |
| 60 | +# Navigate to the frontend directory |
| 61 | +cd optimization_algorithms/frontend |
| 62 | + |
| 63 | +# Install dependencies |
| 64 | +npm install |
| 65 | + |
| 66 | +# Start the development server |
| 67 | +npm start |
| 68 | +``` |
| 69 | + |
| 70 | +The application will be available at `http://localhost:3000`. |
| 71 | + |
| 72 | +## Deployment |
| 73 | + |
| 74 | +The application is deployed on GitHub Pages. To update the deployment: |
| 75 | + |
| 76 | +```bash |
| 77 | +# Build and deploy the application |
| 78 | +npm run deploy |
| 79 | +``` |
| 80 | + |
| 81 | +This will: |
| 82 | +1. Build an optimized production version of the app |
| 83 | +2. Deploy it to the `gh-pages` branch of the repository |
| 84 | +3. Make it available at https://vaidhyamegha.github.io/optimization_algorithms/ |
| 85 | + |
| 86 | +### Notes on Deployment |
| 87 | + |
| 88 | +- The application uses HashRouter for proper routing on GitHub Pages |
| 89 | +- All routes are accessible via hash-based URLs (e.g., `/#/algorithm/bmr`) |
| 90 | +- Any changes pushed to the main branch will not automatically update the live site; you must run `npm run deploy` |
73 | 91 |
|
74 | 92 | ## Usage |
75 | 93 |
|
|
0 commit comments