diff --git a/.eslintrc.js b/.eslintrc.js index 893a5e8..0f2dd4e 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,18 +1,20 @@ module.exports = { root: true, env: { + es2021: true, node: true }, extends: [ 'plugin:vue/essential', 'plugin:prettier/recommended', - '@vue/prettier' + '@vue/prettier', + 'eslint:recommended', + 'plugin:@typescript-eslint/recommended' ], + parser: 'vue-eslint-parser', + plugins: ['@typescript-eslint, vue'], rules: { 'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'warn', 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off' - }, - parserOptions: { - parser: 'babel-eslint' } }; diff --git a/.gitignore b/.gitignore index 4b8f7bc..2c3ef21 100644 --- a/.gitignore +++ b/.gitignore @@ -2,10 +2,12 @@ node_modules /dist -# local env files +# dotenv environment variables files (local env files) .env.local .env.*.local .env +.env.test + # Log files npm-debug.log* @@ -22,7 +24,5 @@ yarn-error.log* *.sln *.sw* -#Electron-builder output -/dist_electron package-lock.json \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..e8fbc9e --- /dev/null +++ b/Dockerfile @@ -0,0 +1,12 @@ +# base image that provides runtime environment for the application +FROM node:16.13 +# where the application code will be copied to in the docker container +WORKDIR /usr/src/app +# copies all files from the current directory (where the Dockerfile is located) to the working directory in the docker image (which we set on line 4) +COPY . . +RUN npm install +RUN npm run build +# Exposes port 4173 to the host machine, so that it can access the Node.js application running inside the Docker container +EXPOSE 8080 +# Specifies the command to run when the Docker container starts +ENTRYPOINT npm run server diff --git a/README.md b/README.md index dde498c..8ccb9e7 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,100 @@
-
+
+
+
+
+
+#### Editing Components
+
+- Edit components by double clicking for the edit modal to show
+- Add additional elements to a component with a live preview of the component code
+- Drag elements on the right side bar to nest elements
+- Establish parent-child component relationships via a dropdown menu when creating or editing components
+
+
+
+#### Adding Routes/Projects
+
+- Create different routes for your application by entering a new route name and pressing enter
+- Any components created on a certain route will be automatically saved to that route
+- Play with multiple projects by clicking the add project icon!
+- Display a tree view of entire application component architecture when the tree icon on navbar is clicked
+
+
+
+#### Tree View of Application Architecture
-## Features
+
+
+
+
-### Code Exporting
+##### Code Exporting
Below is the generated directory structure of the Vue application that is created when you export your design.
@@ -81,10 +118,38 @@ src/
- cmd/ctrl + s: save
- cmd/ctrl + o: open
- cmd/ctrl + n: new project tab
-- cmd/ctrl + t: close project tab
+- cmd/ctrl + w: close project tab
+
+## Running your own local version
+
+---
+
+PreVue was developed using node runtime @ v10.15.0. You should make sure you at least have that version installed to ensure full compatibility. You can download the latest version of node [here](https://nodejs.org/en/)
+
+### Setup
+
+Clone this repo
+
+```
+git clone https://github.com/teamprevue/PreVue.git
+```
+
+Install dependencies
+
+```
+npm i
+```
+
+Run electron app
+
+```
+npm run electron:serve
+```
## Built With
+---
+
- [Vue.js](https://vuejs.org/)
- [Vue Router](https://router.vuejs.org/guide/#html)
- [Vuex](https://vuex.vuejs.org/)
@@ -99,10 +164,14 @@ src/
## Contributing
+---
+
PreVue is currently in beta release. We encourage you to submit issues for any bugs or ideas for enhancements. Also feel free to fork this repo and submit pull requests to contribute as well.
## Authors
+---
+
- **Hubert Lin** [@hubelin](https://github.com/hubelin)
- **Franklin Pinnock** [@pinnockf](https://github.com/pinnockf)
- **Annette Lin** [@al2613](https://github.com/al2613)
@@ -110,4 +179,6 @@ PreVue is currently in beta release. We encourage you to submit issues for any b
## License
+---
+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
diff --git a/babel.config.js b/babel.config.js
deleted file mode 100644
index 3490e08..0000000
--- a/babel.config.js
+++ /dev/null
@@ -1,3 +0,0 @@
-module.exports = {
- presets: ['@vue/app']
-};
diff --git a/build/icon.ico b/build/icon.ico
new file mode 100644
index 0000000..939755e
Binary files /dev/null and b/build/icon.ico differ
diff --git a/electron-builder.json b/electron-builder.json
deleted file mode 100644
index 949816a..0000000
--- a/electron-builder.json
+++ /dev/null
@@ -1,32 +0,0 @@
-{
- "appId": "com.electron.PreVue",
- "mac": {
- "category": "public.app-category.developer-tools",
- "icon": "dist/icon.icns"
- },
- "files": ["out"],
- "nsis": {
- "createDesktopShortcut": "always"
- },
- "dmg": {
- "contents": [
- {
- "x": 110,
- "y": 150
- },
- {
- "x": 240,
- "y": 150,
- "type": "link",
- "path": "/Applications"
- }
- ]
- },
-
- "publish": [
- {
- "provider": "s3",
- "bucket": "prevue-app"
- }
- ]
-}
diff --git a/public/favicon.ico b/favicon.ico
similarity index 100%
rename from public/favicon.ico
rename to favicon.ico
diff --git a/public/index.html b/index.html
similarity index 81%
rename from public/index.html
rename to index.html
index 7aaf018..3c37552 100644
--- a/public/index.html
+++ b/index.html
@@ -4,7 +4,7 @@
-
+
-