Bluedoc
An open-source document management tool for enterprise self host.
Overview
Setting up the BlueDoc development environment can seem daunting at first, but with a clear understanding of the options available, it can be accomplished smoothly. BlueDoc offers two primary methods for deployment: using Docker or a local machine setup. Each method has its own set of requirements and offers flexibility depending on your preferences and existing infrastructure.
Whether you are a developer looking to collaborate on a project or just interested in exploring BlueDoc, understanding the setup process is key to unlocking all its features. With the right configurations and a few commands, you'll have a fully functional development environment in no time.
Features
- Two Setup Approaches: Choose between Docker or local installation based on your comfort level and resources.
- Default Admin Credentials: Easily access the admin panel with preconfigured login details (admin@bluedoc.io / 123456).
- Docker Convenience: Spin up the development environment rapidly using a simple command (
docker-compose up dev), assuming Docker is already running. - Local Development Flexibility: Set up using your own machine with specific environment variables to access all features efficiently.
- Webpack Dev Server: Utilize
yarn startto launch the webpack dev server for real-time updates and easier debugging. - Rails Integration: Start the Rails server simply with the
rails scommand for a seamless development experience. - PlantUML Support: Install the plantuml-service to generate UML diagrams effortlessly, enhancing your project documentation.
- Ruby on Rails
Ruby on Rails, often referred to as Rails, is an open-source web application framework written in Ruby. Known for its convention over configuration and don't repeat yourself (DRY) principles, Rails simplifies and accelerates the development of database-backed web applications.
- Styled Components
Styled Components is a popular library for styling React components using CSS syntax. It allows you to write CSS in your JavaScript code, making it easier to create dynamic styles that are specific to each component.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.