README.md

Odin

Odin is a messaging bus framework that works with a standard MongoDB database.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Odin lets your apps communicate with other Odin-integrated apps. It is a lightweight and efficient framework, and it uses MongoDB as the underlying database. This offers high-availability and cheap/free infrastructure for easy implementation.

Built With

• Java
• Apache Maven
• MongoDB

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Java JDK 11
• Apache Maven

Installation

1. Clone the repo

   git clone https://github.com/LeelaChacha/odin.git

2. Build and Verify

   mvn verify

Usage

This framework can be used in your projects with jitpack maven repository. Add jitpack repository to your settings.xml or your pom.xml

settings.xml

    ...
   <profiles>
        <profile>
            <id>jitpack-repo</id>
            <repositories>
                <repository>
                    <id>jitpack.io</id>
                    <url>https://jitpack.io</url>
                </repository>
            </repositories>
        </profile>
    </profiles>

    <activeProfiles>
    <activeProfile>jitpack-repo</activeProfile>
    </activeProfiles>
    ...

OR

pom.xml

    ...
   <repositories>
        <repository>
            <id>jitpack.io</id>
            <name>Jitpack Maven Repository</name>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>
    ...

After that, Odin can be used directly as a dependency in your project.

    ...
   <dependency>
      <groupId>com.github.LeelaChacha</groupId>
      <artifactId>odin</artifactId>
      <version>__Tag__</version>
    </dependency>
    ...

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Contact

Hukumraj Singh Deora - LinkedIn

Project Link: https://github.com/LeelaChacha/odin