Skip to content

Commit

Permalink
Revert to Vue CLI to fix GitHub Pages Deployment (#2203)
Browse files Browse the repository at this point in the history
Revert to Vue CLI to fix GitHub Pages Deployment

Although Vite boasts better performance and is maintained actively,
its usage for GitHub Pages deployment requires specifying the base of the
deployment URL in the config. This makes it inconvenient as all existing
deployment dashboards must update the base respective to their URLs.  

Let's revert to Vue CLI temporarily to fix this.
  • Loading branch information
ckcherry23 committed May 14, 2024
1 parent f4cad78 commit 170e951
Show file tree
Hide file tree
Showing 12 changed files with 11,238 additions and 4,028 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ node_modules
/frontend/public/
!/frontend/public/favicon.ico
!/frontend/public/index.html
/frontend/.eslintcache
/frontend/.stylelintcache

reposense-report/
docs/_site/
Expand Down
2 changes: 1 addition & 1 deletion docs/dg/learningBasics.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ It is necessary for you to learn the basics of Vue.js, Pug, and SCSS before work
<box type="info" seamless>

Vue.js uses JavaScript as its programming language. Before learning **Vue.js**, you may need to first get yourself familiar with JavaScript syntax first.
You can refer to the [Javascript documentation](https://devdocs.io/javascript/) to learn the basic syntax. There are plenty of other resources available and please feel free to find the resource most suitable for you. Do note that RepoSense uses ES6 over CommonJS.
You can refer to the [Javascript documentation](https://devdocs.io/javascript/) to learn the basic syntax. There are plenty of other resources available and please feel free to find the resource most suitable for you.
</box>

RepoSense uses **Vue.js** (Vue3) in its front-end implementation. In particular, major user interface components, such as [summary view](report.html#summary-view-v-summary-js), [authorship view](report.html#authorship-view-v-authorship-js), and [zoom view](report.html#zoom-view-v-zoom-js), are implemented as Vue components. The corresponding source files are in `frontend/src`.
Expand Down
6 changes: 0 additions & 6 deletions docs/ug/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,3 @@ Possibly, you may have some file names with [special characters](https://docs.mi
### Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report

The files of these types may be [binary files](https://en.wikipedia.org/wiki/Binary_file). *RepoSense* will group binary files under one single file type `binary`. Common binary files include images (`.jpg`, `.png`), applications (`.exe`), zip files (`.zip`, `.rar`) and certain document types (`.docx`, `.pptx`).

<!-- ------------------------------------------------------------------------------------------------------ -->

### RepoSense doesn't work on the browser

RepoSense uses ES6, a version of JavaScript widely supported by [most browsers](https://caniuse.com/?search=es6). Please use RepoSense with a browser that supports ES6.
4 changes: 1 addition & 3 deletions frontend/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
{
"env": {
"browser": true,
"node": true,
"es2022": true
"browser": true
},
"extends": [
"airbnb-base",
Expand Down
5 changes: 5 additions & 0 deletions frontend/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
presets: [
'@vue/cli-plugin-babel/preset',
],
};
1 change: 0 additions & 1 deletion frontend/cypress/cypress.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ module.exports = defineConfig({
e2e: {
setupNodeEvents(on, config) {},
baseUrl: 'http://localhost:9000',
chromeWebSecurity: false,
specPattern: 'tests/**/*.cy.{js,jsx,ts,tsx}',
supportFile: 'support.js',
},
Expand Down
Loading

0 comments on commit 170e951

Please sign in to comment.