Sup'per Card Project

The Sup'per Card project was carried out for the preparatory school Sup'perform in Montpellier. The goal of the project is to create a tool allowing students to review their courses using flashcards. This project was developed during my work-study year at Defacto in Narbonne.

Installation

Follow these steps to set up the project on your local machine.

1. Clone the Repository

   First, clone the repository to your local machine:

   git clone https://github.com/your-github-username/your-repo-name.git

2. Install Composer Dependencies

   Navigate to the project root in your terminal and run the following command to install the Composer dependencies:

   cd your-repo-name
   composer install

3. Install NPM Dependencies

   Still in the project root, install the NPM dependencies:

   npm install

4. Configure your Environment

   Duplicate the .env.example file in the project root and rename it to .env:

   cp .env.example .env

   Open the .env file and set the DB_DATABASE, DB_USERNAME, and DB_PASSWORD environment variables to match the credentials of your database.

5. Generate an Application Key

   Laravel requires you to have an app encryption key which is generally randomly generated and stored in your .env file. You can run the following command to generate this key:

   php artisan key:generate

6. Run Migrations

   Lastly, run the following command in your terminal to run database migrations:

   php artisan migrate

7. Start the Server

   Now you are ready to start the server:

   php artisan serve

   Now, you should be able to access the application via http://localhost:8000.

Please note that this is a basic setup. Depending on your application, you may need to run additional commands or configure additional components such as a queue worker or a task scheduler.

Technologies Used

This project was built using the following technologies:

Laravel

Laravel is a free, open-source PHP web framework, created by Taylor Otwell and intended for the development of web applications following the model–view–controller (MVC) architectural pattern and based on Symfony.

Livewire

Livewire is a full-stack framework for Laravel that makes building dynamic interfaces simple, without leaving the comfort of Laravel.

MariaDB

MariaDB is a community-developed, commercially supported fork of the MySQL relational database management system (RDBMS), intended to remain free and open-source software under the GNU General Public License.