-
Notifications
You must be signed in to change notification settings - Fork 323
docs(readme): modernize structure, add demo, checklist features, and badge section #602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,137 @@ | ||
| # Current status | ||
|
|
||
| As some are aware, due to a chronic lack of time and health issues, I' haven't been the fastest to answer, implement new features or fix bugs., so I just want to inform everyone on the current status of the project. | ||
| At the moment my health is not the strongest, this combined with a heavy workload means that I'm simply not able to keep a very close eye on librebooking, this does NOT mean that this project is dead, in fact the usage on my workplace has steadily increased and will continue to do so in a nearby future, what this means is that in the coming months I won't be able to do much, besides fixing breaking bugs or merge pull requests. | ||
| I'm hoping this phase will pass quickly and that soon I will be able to a more active role, especially implementing new features. | ||
| So what can you do to help, first thing, fork the project, even if you are not a coder, fork the project, the more that have the code the better. | ||
| Second, if you found a bug submit an issue. | ||
| Third, if you managed to fix or trace the problem update the issue, even you can't code, others might be able to quickly provide a fix and maybe even submit a pr. | ||
| Finally if you can code, please contribute to the project even if it's something simple, like fixing grammatical errors all the help is appreciated. | ||
| # Librebooking | ||
|
|
||
| ## Community discussion channel on Discord | ||
| [](https://github.com/LibreBooking/app/issues) | ||
| [](https://github.com/LibreBooking/app/commits) | ||
| [](https://github.com/LibreBooking/app/releases) | ||
| [](./LICENSE.md) | ||
|
|
||
| There is a community discussion channel on Discord at | ||
| <https://discord.gg/4TGThPtmX8> (If this link doesn't work please file an Issue. | ||
| We set the link to never expire but for some reason it still keeps becoming | ||
| invalid) | ||
| [](https://github.com/LibreBooking/app/stargazers) | ||
| [](https://github.com/LibreBooking/app/network) | ||
|
|
||
| ## TODO list | ||
| [](https://www.php.net/) | ||
| [](https://www.mysql.com/) | ||
|  | ||
|  | ||
|
|
||
| Because LibreBooking is an opensource project, there are some things we have to do to make it better. Here is a list of things you can do if you're interested in helping out | ||
| [](https://github.com/LibreBooking/docker) | ||
| [](https://github.com/LibreBooking/docker) | ||
|
|
||
| ## Welcome to LibreBooking | ||
| [](https://discord.gg/4TGThPtmX8) | ||
| [](https://github.com/LibreBooking/app/wiki) | ||
|
|
||
| This is a community effort to keep the OpenSource [GPLv3](./LICENSE.md) LibreBooking alive, see [History](./doc/HISTORY.md) | ||
| ⭐ Star us on GitHub — it motivates us a lot! | ||
|
|
||
| ### Note | ||
| 🔥 Join the community: [Discord discussion channel](https://discord.gg/4TGThPtmX8) . | ||
|
|
||
| The update project is currently in the beta phase; testing and participation from all users and administrators are required. | ||
| ## Table of Contents | ||
|
|
||
| ## What's new? | ||
| - [About](#-about) | ||
| - [Features](#-features) | ||
| - [Screenshots](#-screenshots) | ||
| - [Installation & Deployment](#-installation--deployment) | ||
| - [Developer Documentation](#-developer-documentation) | ||
| - [Configuration & Theming](#-configuration--theming) | ||
| - [ReCaptcha](#-recaptcha) | ||
| - [Community & Support](#-community--support) | ||
| - [Contributing](#-contributing) | ||
| - [Roadmap](#-roadmap) | ||
| - [License](#-license) | ||
|
|
||
| - Update to Bootstrap 5 and migration of icons to Bootstrap Icons. | ||
| ## 🚀 About | ||
|
|
||
|  | ||
| **LibreBooking** is an open-source scheduling solution, forked from Booked Scheduler. It offers a flexible, mobile-friendly, and extensible interface for organizations to manage resource reservations. The repository for the last open source version of Booked Scheduler is maintained here; the `develop` branch contains the latest working code (beta), while `master` is the stable release. | ||
|
|
||
| - Design changes. | ||
| ## ✨ Features | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| - [x] Multi-resource booking & waitlists | ||
| - [x] DataTables for advanced listings | ||
| - [x] Role-based access control | ||
| - [x] Quotas and credits for reservations | ||
| - [x] Granular usage reporting | ||
| - [x] Responsive Bootstrap 5 interface | ||
| - [x] Custom themes and color schemes | ||
| - [x] Plugin-ready architecture | ||
| - [x] Outlook/Thunderbird integration through ics | ||
|
|
||
| - "Back to top" button on all pages. | ||
| ## 📸 Screenshots | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| - Rename Web/booked.css to Web/librebooking.css (this is no longer Booked Schedule ;-) ). | ||
| ## 🔧 Installation & Deployment | ||
|
|
||
| - Ability to change the color scheme in `config.php $conf['settings']['css.theme'] = 'default'` and/or customize an existing one in `Web/css/librebooking.css` | ||
| ### Manual Installation | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| To run LibreBooking from a prebuilt release, your server needs: | ||
|
|
||
| - Use of DataTables. | ||
| - PHP >= 8.2 with the extensions: pdo, mbstring, openssl, tokenizer, json, curl, xml, ctype, bcmath, fileinfo | ||
| - A web server like Apache or Nginx | ||
| - MySQL >= 5.5 | ||
| For full setup instructions, see [INSTALLATION.md](./doc/INSTALLATION.md) | ||
|
|
||
|  | ||
| ### Docker Deployment | ||
|
|
||
| - Removal of obsolete libraries (e.g. Owl, FloatThead). | ||
| LibreBooking is available as a Docker container. See [LibreBooking Docker README](https://github.com/LibreBooking/docker) for complete setup. | ||
|
|
||
| ## Prerequisites | ||
| ```bash | ||
| git clone https://github.com/LibreBooking/docker.git | ||
| cd docker | ||
| docker-compose up -d | ||
| ``` | ||
|
|
||
| - PHP 8.1 or greater | ||
| - MySQL 5.5 or greater | ||
| - Web server (Apache, IIS) | ||
| ## 💻 Developer Documentation | ||
|
|
||
| ## Installation instructions | ||
| - See [doc/README.md](./doc/README.md) for developer notes. | ||
| - See [doc/API.md](./doc/API.md) for API notes. | ||
| - See [doc/Oauth2-Configuration.md](./doc/Oauth2-Configuration.md) for Oauth2 configuration. | ||
| - See [doc/SAML-Configuration.md](./doc/SAML-Configuration.md) for SAML configuration. | ||
| - Codebase follows PSR-12 standards and GitHub Flow. | ||
|
|
||
| [Full install instructions](./doc/INSTALLATION.md) | ||
| ## 🎨 Configuration & Theming | ||
|
|
||
| ## Developer Documentation | ||
| - Change theme via `config.php`: | ||
|
|
||
| [developer documentation](./doc/README.md) | ||
| ```php | ||
| $conf['settings']['css.theme'] = 'default'; | ||
| ``` | ||
|
|
||
| ## Help | ||
| - Theme options: 'default', 'dimgray', 'dark_red', 'dark_green', 'french_blue', 'pastel_blue' | ||
| - Customize `Web/css/librebooking.css`. | ||
|
|
||
| Please consult the wiki for more help <https://github.com/LibreBooking/app/wiki> | ||
| ## 🔒 ReCaptcha | ||
|
|
||
| ## REPO | ||
| As of 09-Mar-2023, ReCaptcha integration updated to v3. Generate new keys for your domain if using ReCaptcha. | ||
|
|
||
| <https://github.com/LibreBooking/app> | ||
| ## 💬 Community & Support | ||
|
|
||
| ## ReCaptcha | ||
| - [Discord](https://discord.gg/4TGThPtmX8) | ||
| - [Wiki](https://github.com/LibreBooking/app/wiki) | ||
| - [Issues](https://github.com/LibreBooking/app/issues) | ||
| - [Discussions](https://github.com/LibreBooking/app/discussions) | ||
|
|
||
| 09/03/2023 - The ReCaptcha integration has been updated to v3, you will need to generate new keys for your website if you are using it on your website. | ||
| ## 🤝 Contributing | ||
|
|
||
| ## Docker usage | ||
| - Fork, file issues, suggest improvements. | ||
| - Even non-coders can help by reporting bugs, testing, updating issues. | ||
| - PRs welcome (docs, features, refactoring, fixes). | ||
| - See CONTRIBUTING.md | ||
|
|
||
| For information on how to use LibreBooking in a Docker container see: | ||
| <https://github.com/LibreBooking/docker> | ||
| ## 💡 Roadmap | ||
|
|
||
| _Work in progress – roadmap to be defined._ | ||
| Want to suggest a feature? [Open an issue](https://github.com/LibreBooking/app/issues) or join the [Discord discussion channel](https://discord.gg/4TGThPtmX8). | ||
|
|
||
| ## 📜 License | ||
|
|
||
| This project is licensed under **GPL-3.0**. | ||
|
|
||
| ## 🙏 Acknowledgments | ||
|
|
||
| Forked from Booked Scheduler. Thanks to all contributors and the community. | ||
|
|
||
| [Back to top](#librebooking) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.