🍕 Croc Express 🍔

About   |   Features   |   Technologies   |   Requirements   |   Importation   |   Starting   |   License  

🎯 About

• PHP Version : 8.2
• Dependencies used :
  • DomPdf
  • Toastr
  • Select2
• Depends on a Database
• Every adding and edit of the shopping cart is done with fetch
• The project architecture is in MVC

✨ Features

User Side :

✔️ Log in / Create an account
✔️ Edit your profile / Log out
✔️ Add a product or a menu to the shopping cart
✔️ Look, Edit, Validate (with or without delivery) your shopping cart
✔️ Consult your orders et download if needed every order in PDF
✔️ Send a message to the administrators

Administrators Side :

✔️ Consult every order of all the users and download if needed every order in PDF
✔️ Consult your sales revenues and your flagship products or menus during the last 7 days
✔️ Add / Edit / Delete products, menus, foods and categories
✔️ Create / Edit / Delete coupons

🚀 Technologies

The following technologies were used for this project :

• PHP
• JavaScript
• MySQL

✅ Requirements

Before starting 🏁, you need composer and git installed.

⬇️ Importation

Import the Database

1. In PHPMyAdmin create a database called croc_express
2. Collect the database with the example datas in the folder database/models/
3. Drag and drop the file croc_express.sql in the database croc_express on PHPMyAdmin

🔏 Configuration

Configure the config file

1. Edit config.example.php with the Database's name (DATABASE) and the Project's name (PROJECT_NAME)
2. Rename config.example.php to config.php

🏁 Starting

# Clone the project
$ git clone https://github.com/Raxuis/Croc-Express.git

# Go to the project's root folder
$ cd Croc-Express

# Install the dependencies
$ composer install

# Use MAMP/XAMP/LAMP or WAMP and start the server

# The server will initialize at the URL <http://localhost:8888/>

# Then, go to the URL <http://localhost:8888/Croc-Express/public/>

# Everything should work perfectly fine 😃

⚠️ To be sure that everything works you can wipe the session of localhost thanks to the path ?page=killall.

Connection datas

Different datas are included in the database to be able to try the website. Orders were also placed using the administrator's account.

Administrator account

• Email : admin@admin.fr
• Password : password

User account

• Email : user@user.fr
• Password : password

📝 License

This project is under MIT license. For more details, check the LICENSE.

Made with ❤️ by Raphaël and Benoît

 

Go back to top