https://github.com/guibranco/bookmarks-manager-api
๐๏ธ๐A RESTful API for managing bookmarks, built with PHP and MySQL, using the GuiBranco\Panckage library for a structured and efficient backend. Designed to integrate seamlessly with the Bookmark Manager UI for storing, organizing, and retrieving bookmarks.
https://github.com/guibranco/bookmarks-manager-api
Last synced: 7 months ago
JSON representation
๐๏ธ๐A RESTful API for managing bookmarks, built with PHP and MySQL, using the GuiBranco\Panckage library for a structured and efficient backend. Designed to integrate seamlessly with the Bookmark Manager UI for storing, organizing, and retrieving bookmarks.
- Host: GitHub
- URL: https://github.com/guibranco/bookmarks-manager-api
- Owner: guibranco
- License: mit
- Created: 2025-02-27T16:34:30.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T16:50:01.000Z (8 months ago)
- Last Synced: 2025-02-27T23:31:29.308Z (8 months ago)
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ๐๏ธ๐ Bookmarks Manager (API)
A **RESTful API** for managing bookmarks, built with **PHP 8.3** and **MySQL**, using the **GuiBranco\Panckage** library for structured and efficient development. Designed to integrate seamlessly with the **Bookmark Manager UI** to store, organize, and retrieve bookmarks.
## ๐ Features
- ๐ **Bookmark Management** โ Create, update, delete, and retrieve bookmarks.
- ๐ท **Folder and Tag Organization** โ Categorize bookmarks efficiently.
- ๐ **Search & Filtering** โ Find bookmarks quickly.
- ๐ก **Secure & Scalable** โ Built with modern PHP best practices.
- ๐งช **Unit and Integration Tests** โ Ensuring reliability.
- ๐ณ **Docker Support** โ Easily run and test in an isolated environment.
- โ๏ธ **GitHub Actions for Migrations** โ Automating database schema updates.## ๐ Tech Stack
- **Frontend**: [Bookmarks Manager UI](https://github.com/guibranco/bookmarks-manager-ui/)
- **Backend**: PHP 8.3
- **Database**: MySQL
- **Libraries**: [GuiBranco\Pancake](https://github.com/guibranco/pancake)
- **Testing**: Unit and Integration Tests with PHPUnit
- **Containerization**: Docker
- **CI/CD**: GitHub Actions for build, test, database migrations, and deployments## ๐ฆ Installation
Clone the repository and install dependencies:
```bash
# Clone the repo
git clone https://github.com/guibranco/bookmarks-manager-api.git
cd bookmarks-manager-api# Install dependencies
composer install
```## ๐ง Usage
### Start the API Locally
```bash
php -S localhost:8000 -t public
```### Run the Test Suite
```bash
docker-compose up -d # Start the test database
tests/run-tests.sh # Execute tests
```## ๐ Database Migrations
Migrations are automatically applied via **GitHub Actions** during deployment. To run them manually:
```bash
php artisan migrate
```## ๐ License
This project is licensed under the [MIT License](LICENSE).---
๐ก **Contributions are welcome!** Feel free to submit issues or pull requests to improve the project. ๐