aubert-alexis/symfony4-api-starter

1.0 2020-01-06 10:21 UTC

Requires

• php: ^7.1.3
• ext-ctype: *
• ext-iconv: *
• api-platform/api-pack: ^1.2
• lexik/jwt-authentication-bundle: ^2.6
• sensio/framework-extra-bundle: ^5.1
• symfony/asset: 4.2.*
• symfony/console: 4.2.*
• symfony/debug-bundle: 4.2.*
• symfony/dotenv: 4.2.*
• symfony/expression-language: 4.2.*
• symfony/flex: ^1.1
• symfony/form: 4.2.*
• symfony/framework-bundle: 4.2.*
• symfony/monolog-bundle: ^3.1
• symfony/orm-pack: *
• symfony/process: 4.2.*
• symfony/security-bundle: 4.2.*
• symfony/serializer-pack: *
• symfony/swiftmailer-bundle: ^3.2
• symfony/translation: 4.2.*
• symfony/twig-bundle: 4.2.*
• symfony/validator: 4.2.*
• symfony/web-link: 4.2.*
• symfony/webpack-encore-bundle: ^1.7
• symfony/yaml: 4.2.*

Requires (Dev)

• doctrine/doctrine-fixtures-bundle: ^3.1
• fzaninotto/faker: ^1.8
• symfony/debug-pack: *
• symfony/maker-bundle: ^1.11
• symfony/profiler-pack: *
• symfony/test-pack: *
• symfony/web-server-bundle: 4.2.*

Conflicts

• symfony/symfony: *

Replaces

• paragonie/random_compat: 2.*
• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php56: *
• symfony/polyfill-php70: *
• symfony/polyfill-php71: *

proprietary

README

Guide

This is a simple starter who can be used for any project with back-office. SB admin 2 template is implemented for the design.

features:

Security

• Login -> check your roles and redirect ( ROLE_ADMIN -> BO | ROLE_USER -> FO) - Check tips section for credentials
• Registration form -> simple user registration
• Forgot password -> in localhost email is not sended, you have to check the debug bar on the mail icon you will find the url to reset your password

Back-office

• Dashboard -> actually, he is so simple only the count of users registred
• User -> table with CRUD and datatable
• Profil (at right on top) -> edit your personnal informations
• Parameter (at right on top) -> change your password

API

• List of users -> GET /api/users {access_token} Get all users form admin

• Single user -> GET /api/users/{id} {access_token} Get a single user for admin and owner

• Update user -> PUT /api/users/{id} {access_token} Update a single user for admin and owner

• Login -> GET /api/login_check Login

• Register -> POST /api/users {access_token} Register a new User

• Forgot password -> POST forgot-password {access_token} Forgot password by email

Tips

Login :

• USER - [e-mail] / user
• ADMIN - [e-mail] / admin

Title :

Sf4-Starter on title of pages -> config/packages/twig.yaml globals -> const_website_title

Installation

1 - Composer

Download dependencies needed for project : composer install

2 - Database

IMPORTANT : change the .env with your information.

Create the database : php bin/console doctrine:database:create

Update the database : php bin/console doctrine:migration:migrate

3 - Fixtures

Load random fake data. php bin/console doctrine:fixtures:load

4 - Server

Launch server. php bin/console server:run