@algovisio/container
v0.1.0
Published
Container for AlgoVisio Apps
Downloads
7
Readme
AlgoVisio Container
This is a container simulating the environment in which a AlgoVisio App runs.
Getting Started
We recommend that you use our Create AlgoVisio App if you want to create a development environment.
Prerequisites
A package manager like npm is required.
Installing
First you have to clone this package to your local machine.
In the root directory run:
npm install
And coding style tests
The eslint coding style by AirBnB is enforced.
Scripts
npm run start
Starts a server hosting the build container on port 3000. You can access it via localhost:3000. It expects a visualization to be hosted on port 3001.
npm run dev
Like npm run, just that it compiles the code just in time. We recommend to build
and then start
instead of using dev
.
npm run build
Builds the package. It puts the compiled Container in the out folder and the compiled src
into dist
.
npm run lint
Runs eslint in auto-fix mode.
npm run test
Currently there are no tests specified :(
Built With
- React - Framework
- Next.js - SSR framework
- Express - NodeJS Server
- Material-UI - Design Framework
- NPM - Dependency Management
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Marcel Mittenbühler - Initial work - MMittenbuehler
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details