https://github.com/ghiftee/hngx-chromex
https://github.com/ghiftee/hngx-chromex
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ghiftee/hngx-chromex
- Owner: Ghiftee
- License: mit
- Created: 2023-09-28T17:41:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-02T12:27:03.000Z (over 2 years ago)
- Last Synced: 2025-02-02T10:31:25.352Z (over 1 year ago)
- Language: PHP
- Homepage: https://chrome-extension-3rhg.onrender.com
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CHROME EXTENSION BACKEND
> ## About this project
This project is the backend for the chrome extension app which stores recorded videos, and renders pages with the videos as needed. This documnet contains all endpoints created and their usuage.
> ## Installation
1. Clone the repository.
2. Install dependencies with `composer install`.
3. Set up your database configuration in `.env`.
4. Run migrations with `php artisan migrate`.
5. Start the development server with `php artisan serve`.
> ## API Endpoints
- view all videos in db(METHOD: GET): `https://chrome-extension-3rhg.onrender.com/api/`
- submit a recorded video(METHOD: POST): `https://chrome-extension-3rhg.onrender.com/api/submit`
- display a specific video by id(METHOD: GET): `https://chrome-extension-3rhg.onrender.com/api/getVideo/{id}`
- search for videos by name or id(METHOD: GET): `https://chrome-extension-3rhg.onrender.com/api/search/{nameOrId}`
> ## LICENSE
This project is [MIT licensed](./LICENSE)