Git Product home page Git Product logo

jo-2024-symfo's Introduction

JO-2024 G7 - API

Back-end expertise : Emilie Tombuyses

Front-end repository : https://github.com/ETombuyses/jo2024-front

Used technologies

Symfony 4

Back-end expertise

You can find my expertise report in this repository (dossier-expertise-back-end.pdf) Have a nice reading !

How to use the API ?

Documentation

API documentation : https://jo2024g7.docs.apiary.io/#

Installation

To use the API, first clone this repository. Then run composer install in the project :

composer install

Then you have to create the database. In order to do so you can either import the jo_2024_database_full.sql from PHP my admin or import it via command line from the database/database_creation folder with the following command :

mysql -u <username> -p <password> < jo_2024_database_full.sql

replace < username > and < password > by your personal username and password for mysql.

Then start you mysql server or keep you Mamp / Xampp running

mysql.server start

You can now modify the .env file to suit your configuration. Modify the "root" username, add a password and change you sql port if necessary.

DATABASE_URL=mysql://root:@127.0.0.1:3306/jo_2024?serverVersion=5.7

Run the API

You can now run the following command in the project:

php -S 127.0.0.1:8080 -t public 

The port needs to be 8080 or the front-end part of the project will not work.

You can now open you browser on http://127.0.0.1:8080/ and use the API documentation to use the routes.

More about the database creation :

Check the database folder. It includes the original JSON files and the PHP script used to inject data into the database.

jo-2024-symfo's People

Contributors

etombuyses avatar

Watchers

 avatar  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.