https://github.com/oslabs-beta/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.
https://github.com/oslabs-beta/dockerlocal
development-tools docker gui-application interconnected-repositories
Last synced: 7 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/oslabs-beta/dockerlocal
- Owner: oslabs-beta
- License: mit
- Created: 2020-06-20T16:24:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-26T04:36:01.000Z (almost 4 years ago)
- Last Synced: 2025-04-30T19:42:07.174Z (10 months ago)
- Topics: development-tools, docker, gui-application, interconnected-repositories
- Language: TypeScript
- Homepage: https://dockerlocal.io
- Size: 4.57 MB
- Stars: 150
- Watchers: 8
- Forks: 7
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
3. Open the env.ts file in our root directory and paste your github user ID and access token
4. npm install and npm start
5. Add a Project
6. Add Repos to your project
7. Choose which repos you'd like included, click Clone Repos
8. 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](https://www.typescriptlang.org/) - Language used
* [Electron](https://www.electronjs.org/) - Native Desktop Application Framework
* [React.js](https://reactjs.org/) - Front end library used
* [Node.js](https://nodejs.org/en/) - The web framework used
* [npm](https://www.npmjs.com/) - Package Manager
* [Webpack](https://webpack.js.org/) - Dependency Management
* [Bulma](https://bulma.io/) - CSS Framework
* [TSlint](https://palantir.github.io/tslint/) - Linter
## Contributing
Please read [CONTRIBUTING.md](https://github.com/oslabs-beta/DockerLocal/blob/master/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](https://github.com/your/project/tags).
## Authors
* **Vivian Cermeno** - *Co-creator* - [Vcermeno](https://github.com/vcermeno)
* **Kate Chanthakaew** - *Co-creator* - [KateChantha](https://github.com/KateChantha)
* **Tom Lutz** - *Co-creator* - [tlutz888](https://github.com/tlutz888)
* **Katty Polyak** - *Co-creator* - [KattyPolyak](https://github.com/KattyPolyak)
* **Louis Xavier Sheid III** - *Co-creator* - [louisxsheid](https://github.com/louisxsheid)
See also the list of [contributors](https://github.com/oslabs-beta/DockerLocal/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Thank you to everyone who helped support the project.