Code Monkey home page Code Monkey logo

api_rest_sf6's Introduction

Mini Site API

✏️ About

The purpose of this project is to provide a standard REST JSON-API that would allow a mobile application or a full frontend website to display a mini site.

Made with PHP 8, Symfony 6, REST, DDD, SOLID and Hexagonal Architecture.

This project uses Hexagonal Architecture.

This project uses Swagger for the API documentation.

Installation

  • clone the project : [email protected]:kdakhli/api_rest_sf6.git

  • inside the project folder run : composer install

  • setup your database by changing this line in .env file DATABASE_URL=mysql://db_user:[email protected]:3306/db_name

  • connect the db by running the following command at the root of the project : php bin/console doctrine:database:create

  • run this command in order to create the database schema : php bin/console doctrine:schema:create

  • just start the build-in symfony server to begin exploring the api : symfony serve -d then go to http://localhost:8000 to use the API Sandbox

====> Enjoy :)

📁 Structure

├── src
    ├── Application
    │   ├── Command
    │   └── Service
    │
    ├── Domain
    │   ├── Entity
    │   ├── Exception
    │   └── Repository
    │
    ├── Infrastructure
    │    ├── Exception
    │    ├── Persistence
    │    │   ├── Doctrine
    │    │   │   └── Repository
    │    │   └── Exception
    │    └── Request
    │
    ├── UI
    │   └── Rest
    │       ├── Action
    │       ├── DTO
    │       └── Exception
    └── Utils
        ├── Exception
        ├── Serializer
        └── Validation

api_rest_sf6's People

Contributors

kdakhli avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.