ehsaneona/vibe

The Vibe Project

best idea project for handle person vibe

About The Project

This project just handle back-end section of vibe project.

Built With

service major list for to bootstrap project:

• PHP
• Laravel
• JWT
• RESTful

Prerequisites

for install service you should have this requirements.

• requirment

  php : ^8.1

Installation

1. Clone the repo

   git clone https://github.com/iamammiin/vibe-project.git

2. run docker build

   cd vibe-project

3. copy and create new env file

   cp .env.example .env

4. run docker build

   docker-compose build

5. go to in php container

   docker-compose exec vibe_php bash

6. run composer for install packages

   composer install

7. add database config and run this command

   php artisan migrate

8. JWT Configuration

   php artisan jwt:secret

9. generate swagger api document

   php artisan l5-swagger:generate

10. go to this url for see api document

    /api/documentation

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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. See LICENSE.txt for more information.

Contact

Amin.M Mazreali - @iamammiin - [email protected]