Giter Club home page Giter Club logo

naikan's Introduction

Naikan: An Open Source Comprehensive Software Inventory Management Tool for Dev Teams

Tired of scattered spreadsheets and scattered information? Our user-friendly interface simplifies project inventory tool for your dev teams, ensuring seamless access to all information about your projects, whenever they need it. It enables users to manage their projects' essential details, including project name, organization, team, contacts, developers, integrations, licenses, deployments, environments, and technologies used. The tool can be integrated into CI/CD pipelines to automatically push data for new projects and updates.


Features

  • Automated updates: You can automatically push new projects or update existing ones with relevant details from your CI/CD pipeline. This helps to ensure that your software project inventory is always up-to-date.

  • Team management: Naikan allows you to see the teams, developers, and contacts behind each project, making collaboration easier.

  • Integrations: Naikan lets you manage integrations with other tools and services used by your organization, streamlining your workflow.

  • Technologies used: With Naikan, you can track the technologies used by each project, giving you a clear picture of your technology stack.

  • Deployments and environments: Naikan enables you to see deployments, versions, and environments for each project, making it easier to manage your software projects.

  • License management: Naikan lets you keep track of licenses for each project and ensure compliance, preventing any potential legal issues.

  • Git Integration: The Naikan Maven Plugin will collect Git repository information and statistics from your project and push it to Naikan as well.

Installation

curl -LO https://naikan.io/docker-compose.yml
docker-compose up -d

Visit the Naikan for configuration documentation and more information.

Modules

The Naikan Project is a software that consists of four modules: naikan-test, naikan-model, naikan-maven-plugin and naikan.

graph TD;
    naikan-model-->naikan-test;
    naikan-->naikan-model;
    naikan-->naikan-test;
    naikan-maven-plugin-->naikan-model;
    naikan-maven-plugin-->naikan-test;

Naikan Module

The naikan module is the Naikan project. It provides a set of APIs and services that developers can use to register and push their applications data to Naikan. This module also contains the user interface for the application.

Naikan Model Module

The naikan-model module provides the data model that represent their Naikan application data.

Naikan Test Module

The naikan-test module provides a set of tools and utilities for testing this application.

Naikan Maven Plugin Module

The naikan-maven-plugin module provides a maven plugin, which allows to enrich or update the Naikan model automatically from POM, custom provider or a Naikan BOM.

Build on Open Source Software

Naikan is built using open source software technologies, including:

  • Java Temurin
  • Spring Boot
  • Angular
  • PrimeNG, Sakai, ChartJS
  • MongoDB
  • JUnit 5, ArchUnit, Testcontainers
  • Docker

Backers

The Open Source Community



Contributing

If you want to contribute to this project, then follow please these instructions. Follow this documentation starting this application locally.

Website

Visit the Naikan Website for general information, demos and documentation.

naikan's People

Contributors

chizobaonorh avatar dependabot[bot] avatar github-actions[bot] avatar mnhock avatar panilya avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

naikan's Issues

cannot make ldap work with active directory

Hi there,

I'm unable to make ldap work with active directory. Can you provide a working example?

This is what i'm trying:

  - NAIKAN_LDAP_SERVER_URL=ldap://10.10.1.30:389
  - NAIKAN_LDAP_BASEDN=DC=my,DC=domain
  - NAIKAN_LDAP_BIND_USERNAME=administrator
  - NAIKAN_LDAP_BIND_PASSWORD=myverysecretpasswor
  - NAIKAN_LDAP_ANONYMOUS_READ_ONLY=true
  - NAIKAN_LDAP_USER_DN_PATTERNS=CN=*,OU=MAIN,DC=my,DC=domain
  - NAIKAN_LDAP_USERS_SEARCH_BASE=OU=MAIN,DC=my,DC=domain
  - NAIKAN_LDAP_USERS_SEARCH_FILTER=(&(objectCategory=person)(objectClass=user))
  - NAIKAN_LDAP_ACTIVE_DIRECTORY_DOMAIN=my.domain

obviouslly some information were redacted

Enhance Project Filter Handling

  • It should be visible if project filters are applied
  • It should be visible if project filters categories are applied in filter view

Add OpenAPI Schema for the REST API

As part of improving our REST API documentation and providing a more standardized and comprehensive approach, we should integrate the OpenAPI Schema. The json should be under {schema}://{hostname}:{port}/api/public/schema.json and should be generated automatically.

Add Excel export for all projects on dashboard project page

This enhancement aims to provide users with a convenient way to extract project data for analysis, reporting, or further processing. The addition of an Excel export feature will streamline the process and allow users to obtain a comprehensive overview of their projects in a widely used and easily manipulable format.

spring-boot-docker-compose ignore 'dev' profile and uses docker-compose.yml in the project root

Hi, I saw your tweet with a link to this project. I was immediately interested in the technologies used hereπŸ™ƒ. I'd like to help and contribute to the project as well, but I've encountered a problem when launching the project locally.

I don't understand why spring-boot-starter-docker ignores the dev profile and still uses docker-compose in the project root.

This is the console output:

2023-09-16T21:11:25.228+03:00 INFO 66991 --- [ restartedMain] com.enofex.naikan.NaikanApplication : Starting NaikanApplication using Java 20.0.2 with PID 66991 (/Users/panilya/Documents/naikan/naikan-web/target/classes started by panilya in /Users/panilya/Documents/naikan)
2023-09-16T21:11:25.232+03:00 INFO 66991 --- [ restartedMain] com.enofex.naikan.NaikanApplication : The following 1 profile is active: "dev"
2023-09-16T21:11:25.315+03:00 INFO 66991 --- [ restartedMain] .s.b.d.c.l.DockerComposeLifecycleManager : Using Docker Compose file '/Users/panilya/Documents/naikan/docker-compose.yml'
2023-09-16T21:11:26.305+03:00 INFO 66991 --- [utReader-stderr] o.s.boot.docker.compose.core.DockerCli :  Container naikan Created
2023-09-16T21:11:26.311+03:00 INFO 66991 --- [utReader-stderr] o.s.boot.docker.compose.core.DockerCli :  Container naikan Starting
2023-09-16T21:11:26.609+03:00 INFO 66991 --- [utReader-stderr] o.s.boot.docker.compose.core.DockerCli :  Container naikan Started
2023-09-16T21:11:26.610+03:00 INFO 66991 --- [utReader-stderr] o.s.boot.docker.compose.core.DockerCli :  Container naikan Waiting
2023-09-16T21:11:27.119+03:00 INFO 66991 --- [utReader-stderr] o.s.boot.docker.compose.core.DockerCli :  Container naikan Healthy

Thank you.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.