Box

Box is a tool for building scalable microservices from predefined templates. Box is currently in Beta so if you find any issues or have some ideas for features, please open an issue.

Table of contents

• What is Box?
• TOC
• Vision
• Installation
• Development
• Contribute
  • Adding new features or fixing bugs (see Contributing.md)
• License

Vision

Box is an ecosystem for developing microservices using "boxes". "boxes" are microservices built off of basic templates for common microservices roles e.g. api, search, AI, etc. These microservices will be defined in config files and the code will be in base programing languages e.g. python, nodejs, golang, java, etc. or they can be built in a "dialect" or collection of properties for configuring the defined for each base. For example, a web rest api might have CRUD endpoints for different database schemas, and wrappers for communicating with other microservices. At some point, Box will be fully compatible with docker, kubernetes, and other major cloud native applications.

Installation and Usage

(Back to top)

To install Box, clone the repo and run go build . to build a binaray or go run . to run without genarating binaries. Which ever way you chose, when you run the package, you must supply a path for Box to check for a Box project.

Development

(Back to top)

To work on Box, clone the project or fork it. Once you have the source code on your machine, run go mod tidy to install all dependencies locally. If you want to test your work, you can do cd and then go test to run the tests. You can also call go run . example after deleting the Box-genarated python file to see if it compiles the example configurations correctly.

Contribute

(Back to top)

To contribute to Box, clone or fork this repo and follow the instructions above in Development. Once you have a working version of your changes, open a pull request and your code will be review, edited if any bugs are found, and merged into the main code base.

License

This project is licenced under MIT Open Source License.

Additional Info

(Back to top)

If you have questions or comments, feel free to open an issue about it. Leave a star in GitHub or give a clap in Medium if you found Box interesting or useful for your applications.