Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jahidulpabelislam/portfolio-api
Bespoke API for managing projects for my portfolio.
https://github.com/jahidulpabelislam/portfolio-api
api cms crud database headless-cms mysql orm php portfolio
Last synced: about 2 months ago
JSON representation
Bespoke API for managing projects for my portfolio.
- Host: GitHub
- URL: https://github.com/jahidulpabelislam/portfolio-api
- Owner: jahidulpabelislam
- Created: 2018-09-06T21:21:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T22:29:32.000Z (4 months ago)
- Last Synced: 2024-09-13T11:44:30.140Z (4 months ago)
- Topics: api, cms, crud, database, headless-cms, mysql, orm, php, portfolio
- Language: PHP
- Homepage: https://api.jahidulpabelislam.com/v4/
- Size: 764 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Portfolio API
API to manage the projects and their images displayed in my [portfolio](https://jahidulpabelislam.com/). It provides CRUD functionality for the [CMS](https://github.com/jahidulpabelislam/portfolio-cms/) as well as the central source for the projects shown on the actual [portfolio](https://github.com/jahidulpabelislam/portfolio/).
## Why
I wanted a system to quickly and easily manage the projects without having to make code changes which lead to the creation of a CMS. I therefore needed a single source of information for both the CMS and portfolio which is this.
The first two versions were developed within the portfolio. However, from v3, I separated the API (and CMS) from the portfolio for improved maintainability and readability.
## Requirements
- Git
- PHP 8.0+
- PHP PDO
- Composer
- MySQL 5+
- Apache
## Setup
1. Clone repo with `[email protected]:jahidulpabelislam/portfolio-api.git`.
2. Navigate to project folder and run `composer install`.
3. Create new database.
4. A MySQL user with select, insert, update & delete capabilities on the new database.
5. Import `/set-up/base-structure.sql` into the newly created database.
6. Run migrations from `/migrations/*` (if any) into MySQL in the order of the number at the start of the filenames.
7. Copy and fill in example files (in any order).
- Copy `/set-up/Manager-sample.php` and move to `/src/Auth/Manager.php` then update all 3 functions with your auth functionality.
## API
### Endpoints
#### Resources
| URI | Description | `GET` | `POST` | `PUT` | `DELETE` |
|--------------------------------------------------------------------------------------------------------|:-------------------------------------------:|:--------:|:--------:|:--------:|:--------:|
| [/projects/](https://api.jahidulpabelislam.com/v4/projects/) | All projects | ✔ | ✔ | ✖ | ✖ |
| [/projects/{projectId}/](https://api.jahidulpabelislam.com/v4/projects/13/) | A single project | ✔ | ✖ | ✔ | ✔ |
| [/projects/{projectId}/images/](https://api.jahidulpabelislam.com/v4/projects/13/images/) | Images attached to a single project | ✔ | ✔ | ✖ | ✖ |
| [/projects/{projectId}/images/{imageId}/](https://api.jahidulpabelislam.com/v4/projects/13/images/72/) | A single image attached to a single project | ✔ | ✖ | ✖ | ✔ |
#### Auth
| URI | Description | `GET` | `POST` | `PUT` | `DELETE` |
|--------------------------------------------------------------------|:-----------------------:|:--------:|:--------:|:--------:|:--------:|
| [/auth/login/](https://api.jahidulpabelislam.com/v4/auth/login/) | Log in | ✖ | ✔ | ✖ | ✖ |
| [/auth/logout/](https://api.jahidulpabelislam.com/v4/auth/logout/) | Log out | ✖ | ✖ | ✖ | ✔ |
| [/auth/status/](https://api.jahidulpabelislam.com/v4/auth/status/) | Get current auth status | ✔ | ✖ | ✖ | ✖ |