ergomake Goto Github PK

This project is not actively maintained anymore. Ergomake is now Briefer.

Preview environments on every pull-request, for any stack.

Every time you open a PR, Ergomake spins-up your entire application and sends you a preview link.

Anything that you can run in a container, you can run in Ergomake. Our previews may include your back-end, databases, and queues, for example.

Ergomake also supports multi-repo projects.

You can see the complete documentation here.

1. Log into Ergomake.

2. Select the desired organization and click the "Add Repo" button.

3. During the installation process, you'll be prompted to give it access to the repository for which you want to generate previews. Make sure to select all the repositories you need.

   ⚠️ Ergomake can't generate previews if it doesn't have access to a repository.

4. Create a docker-compose.yml file in your repository's .ergomake folder, which should be in the repository's root.

   Ergomake will use this file to generate preview environments.

   # Here's an example docker-compose.yml file
   version: "3.8"
   services:
     # On pull requests, Ergomake can build your own images
     web:
       build: ..
       ports:
         - "8080:8080"
   
     # You can build a second repository by referencing a folder with
     # the desired repository name in a path *outside* your current repository.
     api:
       build: ../../my-backend-repo
       ports:
         - "3001:3001"
   
     database:
       image: mongo
       environment:
         MONGODB_INITDB_ROOT_USERNAME: username
         MONGODB_INITDB_ROOT_PASSWORD: password

5. Open a pull-request and wait for the Ergomake Bot's comment. That comment contains a link to all the applications running within your preview environment.

You can find Ergomake's users and maintainers in GitHub Discussions. There you can ask how to set up Ergomake, ask us about the roadmap, and discuss any other related topics.

You can also reach us directly (and more quickly) in our Discord server.

• Issue Tracker
• Twitter
• LinkedIn
• Ergomake Blog

Licensed under the GNU GPLv3 License.