DockerLocal

DockerLocal is a GUI application that allows you to keep an up-to-date version of the docker compose file for interconnected repositories while doing development work on a single repository.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

What things you need to install the software and how to install them

Mac/Linux
A Github Personal Access Token

Instructions

A step by step series of examples that tell you how to get a development env running

1. Clone our repo
2. Get a personal access token from Github
3. Open the env.ts file in our root directory and paste your github user ID and access token

1. npm install and npm start
2. Add a Project

1. Add Repos to your project

1. Choose which repos you'd like included, click Clone Repos

1. Click Compose when you're ready!

Running the tests

Run npm test in the terminal.

$ npm test

Currently, Jest CLI has set up to run all test suites and display individual test results with the test suite hierarchy.

Testing React Components

We're using: - Jest, a test runner - Enzyme, a testing utility for React

In jest.config.js file: - ts-jest preset to compile Typescript to JavaScript - enzyme-to-json to convert Enzyme wrappers for Jest snappshot matcher.

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Typescript - Language used
• Electron - Native Desktop Application Framework
• React.js - Front end library used
• Node.js - The web framework used
• npm - Package Manager
• Webpack - Dependency Management
• Bulma - CSS Framework
• TSlint - Linter

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

For the versions available, see the tags on this repository.

Authors

• Vivian Cermeno - Co-creator - Vcermeno
• Kate Chanthakaew - Co-creator - KateChantha
• Tom Lutz - Co-creator - tlutz888
• Katty Polyak - Co-creator - KattyPolyak
• Louis Xavier Sheid III - Co-creator - louisxsheid

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

Acknowledgments

• Thank you to everyone who helped support the project.