A CQRS and event sourcing based microservice architecture with Koa
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
The goal of this project is to learn how to write a backend app using Koa. This app should be a RESTful API that can handle books, authors and genre in a MongoDB database.
To spice up this project a little bit, we decided to extend the scope of the project and base it on microservices. We tried to follow a CQRS and event sourcing ideology. We used Koa for our query and write service, Kafka as our event store and MongoDB for our database. We also added KafkaDrop and OpenApi documentation.
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
In this section you will learn how to get the project up and running.
You need a few softwares before things works properly.
-
npm with node
npm install npm@latest -g
-
docker (and don't forget docker-compose if you are on linux)
Below is an example of how you can install the dependancies and set up the app.
-
Clone the repo
git clone https://github.com/alexandrelam/ilog
-
Install npm dependancies for the whole repo
npm install
-
Install npm dependancies for the different services
cd api && npm install
cd .. && cd write-service && npm install
cd .. && cd shared && npm install
-
docker-compose up!
docker-compose up
Make sure no other app are running on port 4000, 4001, 4002, 9000, 2181, 27017, 29092. If the app is not starting because of kafka not initiating fast enough just shutdown the servers and docker-compose back up again.
Use Postman to test the api! (https://www.postman.com/)
For more examples, please refer to the OpenAPI documentation
To seed the db don't forget to execute the command in the container.
docker exec -it fc7e74e0993d npm run seed- Write a cool readme
- Convert whole app to cqrs
- Await group 1 to contact us and build something cool
-
Make a better seeder for wordle -
Create a banking service for CQRS because it's a better example than authors!
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Alexandre LAM - alexandrelam@outlook.com
Thomas BERNARD - thomas.bernard@etu.imt-nord-europe.fr
Project Link: https://github.com/alexandrelam/ilog
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!