Skip to content

Commit

Permalink
Initial Commit;
Browse files Browse the repository at this point in the history
  • Loading branch information
arkanister committed Jul 24, 2021
0 parents commit 30fa499
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# PyInstaller:
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Unit test / coverage reports:
cover/
.tox/
.coverage
.cache
nosetests.xml
coverage.xml

.DS_Store
frontend/node_modules
/dist

# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?


# Pip:
*.lock

*lock.json
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Data Visualization With Python + Vue

This project aims to explore ``plotly`` library to build and serve a dashboard throughout a flask api.

On the other side, to present these plots for users, vue is being used with a bootstrap template.

![Dashboard](media/dashboard.png "Dashboard")

## Running

This project was configured to be easy to use, just follow the bellow steps:

1. Install and configure ``docker`` and ``docker-compose`` in your computer.

2. After that just start docker compose with the following command:

```bash
$ docker-compose up --build backend frontend
```

3. Now it's time to access the [Dashboard](http://localhost:8080/).
## Conclusion
This project was only a prof of concept to try the ``flask`` framework with a web interface written with ``vue`` using ``plotly`` library.
It was very easy to configure this project, build the charts and configure the interface. I believe that it can be used for commercial proposals and be very acceptable.
## Contributors
**Priscilla Trindade** [Github](#)
**Rafael Souza da Silva** [Github](https://github.com/arkanister)

0 comments on commit 30fa499

Please sign in to comment.