@organization-ai-projects/shared-base

Shared Base Library

The Shared Base Library is a TypeScript-based utility library designed to simplify and accelerate development by providing common utility functions and robust abstractions. This project is open-source and available under the MIT License.

---

🌟 Features

• TypeScript-first: Fully typed, ensuring better developer experience and code safety.
• Common utilities: Includes string manipulation, date formatting, object merging, and more.
• Customizable: Designed to integrate seamlessly with diverse projects.
• Extensively tested: High test coverage ensures robust and reliable utilities.
• Open-source: Community-driven and accessible to everyone.

---

🚀 Installation

To add Shared Base Library to your project, use:

npm install @organization-ai-projects/shared-base

Or with Yarn:

yarn add @organization-ai-projects/shared-base

Or with PNPM:

pnpm add @organization-ai-projects/shared-base

---

📚 Usage

Import the functions you need:

import { capitalize, deepMerge, logInfo } from '@organization-ai-projects/shared-base';

const capitalized = capitalize('hello world'); // "Hello world"
logInfo('Application started');

const merged = deepMerge({ a: 1 }, { b: 2 });
console.log(merged); // { a: 1, b: 2 }

Refer to the API Documentation for more details.

---

🛠️ Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Submit a pull request.

Please read our CONTRIBUTING.md for detailed guidelines.

---

📜 Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🙏 Acknowledgements

• Created and maintained by Rémi Bezot.
• Hosted under the organization Organization AI Projects.

---

📣 Feedback

If you encounter any issues or have suggestions, feel free to open an issue on GitHub: Issues.

🌐 Other Languages

This file is also available in French: README.fr.md.