Skip to content

ecoCrafters/ecocrafters-api

Repository files navigation

Build Status Total Downloads Latest Stable Version License

EcoCrafters Laravel API

This repository contains the source code for the EcoCrafters API, a Laravel-based API for the EcoCrafters project. The API provides endpoints to interact with the EcoCrafters platform and perform various operations related to crafts, users, and detection system.

Table of Contents

Installation

  1. Clone the repository: git clone ...

  2. Navigate to the project directory: cd ecocrafters-api

  3. Install the dependencies: composer install

  4. Create a copy of the .env.example file and rename it to .env: cp .env.example .env

  5. Generate the application key: php artisan key:generate

  6. Configure the database connection in the .env file.

  7. Run the database migrations: php artisan migrate

  8. Start the development server: php artisan serve

  9. Open your browser and visit http://localhost:8000 to access the API.

Usage

The EcoCrafters API provides various endpoints to interact with the platform. You can use tools like Postman or cURL to make HTTP requests to these endpoints.

Make sure to authenticate your requests by including the appropriate authentication headers. Refer to the API documentation for details on each endpoint and their required authentication.

API Endpoints

The EcoCrafters API provides the following endpoints by the documentation link below :

https://documenter.getpostman.com/view/11927320/2s93m1Z44Y

Refer to the for more details on each endpoint, their request/response formats, and required authentication.

Contributing

Contributions to the EcoCrafters Laravel API project are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

Before making any contributions, please review our contribution guidelines.

License

This project is only for Capstone Project from C23-PR551 Team MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published