imollm / homeweb-backend

Final project of bachelor's degree

FINAL PROJECT INFORMATICS ENGINEER BACHELOR'S DEGREE

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

Is a final project of UOC informatics engineering degree. About web development, this repository is for build docker environment to execute backend of project.

Built With

• PHP
• Laravel
• MySQL
• Docker
• PHPStorm
• Postman

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• docker
  • Mac OS X

    brew cask install docker

  • Linux

      sudo apt-get update
      sudo apt-get install docker-ce docker-ce-cli containerd.io

  • Windows
    • Download and execute docker installer

Installation

1. Git clone

   cd ~/
   git clone https://github.com/imollm/homeweb-backend

2. Build and deploy

   cd ~/homeweb-backend
   docker-compose up -d

3. Execute init script

   docker ps

   Copy CONTAINER ID of homeweb-backend_webserver

   

   docker exec -it <CONTAINER_ID> sh /var/www/html/deploy/init.sh

   This install dependencies and init database, with test data.

Usage

1. Test with curl

   curl -I http://localhost:8080/homeweb-backend/public/api/properties/index
   HTTP/1.1 200 OK
   Date: Mon, 17 May 2021 15:11:59 GMT
   Server: Apache/2.4.38 (Debian)
   X-Powered-By: PHP/8.0.3
   Cache-Control: no-cache, private
   X-RateLimit-Limit: 60
   X-RateLimit-Remaining: 59
   Access-Control-Allow-Origin: *
   Content-Type: application/json

2. Test with Postman project

   • Install Postman

   • Download postman collection

     wget -O ~/tfg-docker-backend/postman.json https://www.getpostman.com/collections/c02928439a50147cc744

   4.3 Open with postman and test it.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Ivan Moll Moll - [email protected]

Project Link: https://github.com/imollm/homeweb-backend