|
1 | | -# Minos Microservice Aggregate |
| 1 | +<p align="center"> |
| 2 | + <a href="http://minos.run" target="_blank"><img src="https://raw.githubusercontent.com/minos-framework/.github/main/images/logo.png" alt="Minos logo"></a> |
| 3 | +</p> |
2 | 4 |
|
3 | | -[](https://codecov.io/gh/Clariteia/minos_microservice_aggregate) |
4 | | - |
| 5 | +## minos-microservice-aggregate |
| 6 | + |
| 7 | +[](https://pypi.org/project/minos-microservice-aggregate/) |
| 8 | +[](https://minos-framework.github.io/minos-python) |
| 9 | +[](https://github.com/minos-framework/minos-python/blob/main/LICENSE) |
| 10 | +[](https://codecov.io/gh/minos-framework/minos-python) |
| 11 | +[](https://stackoverflow.com/questions/tagged/minos) |
| 12 | + |
| 13 | +## Summary |
5 | 14 |
|
6 | 15 | Minos is a framework which helps you create [reactive](https://www.reactivemanifesto.org/) microservices in Python. |
7 | 16 | Internally, it leverages Event Sourcing, CQRS and a message driven architecture to fulfil the commitments of an |
8 | 17 | asynchronous environment. |
9 | 18 |
|
10 | 19 | ## Documentation |
11 | 20 |
|
12 | | -The official documentation as well as the API you can find it under https://clariteia.github.io/minos_microservice_aggregate/. |
13 | | -Please, submit any issue regarding documentation as well! |
14 | | - |
15 | | -## Set up a development environment |
16 | | - |
17 | | -Minos uses `poetry` as its default package manager. Please refer to the |
18 | | -[Poetry installation guide](https://python-poetry.org/docs/#installation) for instructions on how to install it. |
19 | | - |
20 | | -Now you con install all the dependencies by running |
21 | | -```bash |
22 | | -make install |
23 | | -``` |
24 | | - |
25 | | -In order to make the pre-commits checks available to git, run |
26 | | -```bash |
27 | | -pre-commit install |
28 | | -``` |
29 | | - |
30 | | -Make yourself sure you are able to run the tests. Refer to the appropriate section in this guide. |
31 | | - |
32 | | -## Run the tests |
33 | | - |
34 | | -In order to run the tests, please make sure you have the [Docker Engine](https://docs.docker.com/engine/install/) |
35 | | -and [Docker Compose](https://docs.docker.com/compose/install/) installed. |
36 | | - |
37 | | -Move into `tests/` directory |
38 | | - |
39 | | -```bash |
40 | | -cd tests/ |
41 | | -``` |
42 | | -Run service dependencies: |
43 | | - |
44 | | -```bash |
45 | | -docker-compose up -d |
46 | | -``` |
47 | | - |
48 | | -Install library dependencies: |
49 | | - |
50 | | -```bash |
51 | | -make install |
52 | | -``` |
53 | | - |
54 | | -Run tests: |
55 | | - |
56 | | -```bash |
57 | | -make test |
58 | | -``` |
59 | | - |
60 | | -## How to contribute |
61 | | - |
62 | | -Minos being an open-source project, we are looking forward to having your contributions. No matter whether it is a pull |
63 | | -request with new features, or the creation of an issue related to a bug you have found. |
64 | | - |
65 | | -Please consider these guidelines before you submit any modification. |
| 21 | +The official API Reference is publicly available at [GiHub Pages](https://minos-framework.github.io/minos-python). |
66 | 22 |
|
67 | | -### Create an issue |
| 23 | +## Source Code |
68 | 24 |
|
69 | | -1. If you happen to find a bug, please file a new issue filling the 'Bug report' template. |
70 | | -2. Set the appropriate labels, so we can categorise it easily. |
71 | | -3. Wait for any core developer's feedback on it. |
| 25 | +The source code of this project is hosted at [GitHub](https://github.com/minos-framework/minos-python). |
72 | 26 |
|
73 | | -### Submit a Pull Request |
| 27 | +## Getting Help |
74 | 28 |
|
75 | | -1. Create an issue following the previous steps. |
76 | | -2. Fork the project. |
77 | | -3. Push your changes to a local branch. |
78 | | -4. Run the tests! |
79 | | -5. Submit a pull request from your fork's branch. |
| 29 | +For usage questions, the best place to go to is [StackOverflow](https://stackoverflow.com/questions/tagged/minos). |
80 | 30 |
|
81 | | -## Credits |
| 31 | +## Discussion and Development |
| 32 | +Most development discussions take place over the [GitHub Issues](https://github.com/minos-framework/minos-python/issues). In addition, a [Gitter channel](https://gitter.im/minos-framework/community) is available for development-related questions. |
82 | 33 |
|
83 | | -This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [Minos Package](https://github.com/Clariteia/minos-pypackage) project template. |
| 34 | +## License |
84 | 35 |
|
| 36 | +This project is distributed under the [MIT](https://raw.githubusercontent.com/minos-framework/minos-python/main/LICENSE) license. |
0 commit comments