/bards-database

A self hosted mongodb database dashboard that borrows ideas from firebase database and its dashbaord

Primary LanguageTypeScriptOtherNOASSERTION

BARDS DATABASE

Bards Database is designed to provide a user-friendly interface for managing MongoDB databases according to your preferences. It offers flexibility, ease of use, and powerful features aimed at making database management accessible to all.

Images

Bards Database Authentication Bards Database Projects Bards Database Database dark Bards Database Database light

Disclaimer

This project is currently in development and not intended for production use yet. Our goal is to organize and refine it before making it production-ready. We welcome and encourage contributors to join us in improving the code.

Note: At this stage, Bards Database is more of a rough concept than a fully functional application. It serves as a proof of concept and is still undergoing design and implementation improvements.

Features

  • User Authentication
  • User Management
  • Database Management
  • Data Visualization
  • Data Export & Import
  • Data Backup
  • Third-Party API Integration
  • Plugin Support
  • Customizable Dashboard & Interface
  • Customizable Database Schema & Data Types
  • Integration with Other Tools and Services

We drew inspiration from platforms like Firebase, Supabase, and Pocketbase for the API design and dashboard functionality. The backend is built using Next.js and TypeScript with a custom Express server.

We plan to use Docker Compose to create instances for both the web UI and MongoDB database, which will handle user authentication.

Future Plans

We aim to implement multi-tenant support and additional features over time.

Open Source License

This project is fully open source, licensed under The Developers Parley, a license agreement created by Pherus. This unique agreement allows anyone to use the source code freely, regardless of intent or purpose, as long as it aligns with secular moral constructs and the legal boundaries of their region or country.

Exception: While not mandatory, we encourage contributors to either participate in this project or donate to Pherus. This is more of a gentleman's agreement, not a hard requirement.


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. If you have a suggestion that would make this better, please fork the repository and create a pull request . You can also simply open an issue with the tag "enhancement" and I'll be happy to discuss it with you. Please note we have a code of conduct , please follow it in all your interactions with the project.

How to Contribute

  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

Code of Conduct

Our Code of Conduct is based on the Contributor Covenant, version 2.1.

License

Distributed under the Developers Parley License. See LICENSE for more information.

Acknowledgments

We would like to thank the following people for their contributions to this project:

const contributors = await getContributors(); const contributorList = contributors.map(contributor => contributor.login); const contributorString = contributorList.join(', '); console.log(Special thanks to ${contributorString} for their contributions!); // end automatically get the contributors git accounts