https://github.com/zaharpa/event-management
Event-Management is a REST API for managing events and attendees, developed as part of my course completion. The project utilizes Laravel, MySQL, and Postman for testing and documentation.
https://github.com/zaharpa/event-management
laravel mysql rest-api
Last synced: 4 months ago
JSON representation
Event-Management is a REST API for managing events and attendees, developed as part of my course completion. The project utilizes Laravel, MySQL, and Postman for testing and documentation.
- Host: GitHub
- URL: https://github.com/zaharpa/event-management
- Owner: ZaharPa
- Created: 2024-12-18T11:39:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-23T12:24:13.000Z (over 1 year ago)
- Last Synced: 2025-08-05T11:40:08.957Z (11 months ago)
- Topics: laravel, mysql, rest-api
- Language: PHP
- Homepage:
- Size: 79.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## About Event-Management
Event-Management is a REST API built with Laravel that allows users to manage events and attendees. It provides a robust platform for creating, updating, viewing, and deleting events, as well as managing event attendees.
### Features
- **User Authentication and Authorization**: Secure user authentication and authorization using Laravel Sanctum.
- **Event Management**: Create, update, view, and delete events.
- **Attendee Management**: Add and remove attendees for events.
- **Rate Limiting**: Protect the API from abuse by limiting the number of requests.
- **Real-time Notifications**: Notify users about event updates and attendee actions.
- **Search and Filter**: Search and filter events based on various criteria.
### API Endpoints
- **Authentication**
- `POST /login`: Login a user.
- `POST /logout`: Logout a user.
- **Events**
- `GET /events`: List all events.
- `GET /events/{id}`: View a specific event.
- `POST /events`: Create a new event.
- `PUT /events/{id}`: Update an existing event.
- `DELETE /events/{id}`: Delete an event.
- **Attendees**
- `GET /events/{event_id}/attendees`: List all attendees for an event.
- `POST /events/{event_id}/attendees`: Add an attendee to an event.
- `DELETE /events/{event_id}/attendees/{attendee_id}`: Remove an attendee from an event.
### Tools Used
- **Postman**: Used for testing and documenting the API endpoints.
## Getting Started
### Prerequisites
- PHP >= 8.0
- Composer
- Laravel
- MySQL or any other supported database
### Installation
To get started with Job-board, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/ZaharPa/job-board.git
cd job-board
```
2. Install dependencies:
```sh
composer install
npm install
npm run dev
```
3. Set up the environment:
```sh
cp .env.example .env
php artisan key:generate
```
4. Configure the database in the [.env](http://_vscodecontentref_/0) file and run migrations:
```sh
php artisan migrate
```
5. Seed the database with initial data (optional):
```sh
php artisan db:seed
```
6. Start the development server:
```sh
php artisan serve
```
## License
Job-board is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).
## View Work
