DevTool

This repository provides tooling for testing and debugging Lenra applications. Basically, the devtools can easily launch a Lenra App using the same method as the Lenra Server.

Report Bug · Request Feature

Getting Started

Using Docker Hub

We provide a docker image on Docker Hub that you can use, it contains everything you need to unlock the full potential of the DevTools. We advise you to not use directly this image but to prefer using the Lenra CLI which can launch the devtools from the command line.

(back to top)

Using local docker

You might not want to use the Docker Hub image, if it is the case you can clone this repository and build the docker images following these instructions :

# Go the the client folder
cd client
# Build flutter web
flutter build web --no-tree-shake-icons
# Go to the root of the repository
cd ..
# Build docker image
docker build -t lenra/devtools:local .

You can then use the Lenra CLI to run your application. Just make sure that the lenra.yml file contains this specification to use the devtools image that you build in the previous step :

dev:
  devtool:
    tag: local

Using local environment

To run the devtools locally, not in a Docker container, you can use the following command :

# Go the the client folder
cd client
# Build flutter web
flutter build web --no-tree-shake-icons
# Copy the generated web folder to the server
cp -r build/web ../server/priv/static
# Go to the server folder
cd ../server
# Setup the server project
mix setup
# Start the server
mix phx.server

To update the client, you can use the following command from the client folder :

# Build flutter web
flutter build web --no-tree-shake-icons
# Copy the generated web folder to the server
cp -r build/web ../server/priv/static

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement" or "bug". Don't forget to give the project a star! Thanks again!

(back to top)

License

Distributed under the AGPL License. See LICENSE for more information.

(back to top)

Contact

Lenra - @lenra_dev - contact@lenra.io

Project Link: https://github.com/lenra-io/dev-tools

(back to top)