Welcome to the Benakno API project! This Laravel-based API serves as the backend for your web and mobile applications related to managing "bengkel" (workshops). The name "Benakno" is derived from the Indonesian word meaning "to know," reflecting the API's purpose of providing comprehensive workshop management.
Follow these steps to set up and run the Benakno API on your local machine.
Make sure you have the following prerequisites installed on your system:
- PHP (version 7.4 or higher)
- Composer
- Laravel (install using
composer global require laravel/installer)
-
Clone the repository:
git clone https://github.com/Profixcon/benakno-be-app.git
-
Navigate to the project directory:
cd benakno-be-app -
Install dependencies:
composer install
-
Copy the
.env.examplefile and rename it to.env. Update the database and other relevant configurations.cp .env.example .env
-
Generate the application key:
php artisan key:generate
-
Start the development server:
php artisan serve
The API is now running locally at http://localhost:8000.
Refer to the API documentation for details on available endpoints and how to interact with them. You can access the documentation by visiting http://localhost:8000/api/documentation after starting the development server.
- Workshops: Manage information about workshops.
- Services: Define and update various services offered by workshops.
- Appointments: Schedule appointments for services.
- Users: Handle user authentication and authorization.
If you'd like to contribute to the development of the Benakno API, please follow our contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
We would like to express our gratitude to the Laravel community for providing a robust framework for building web applications.
Happy coding with Benakno API!