Skip to content

A website offering users a list of cocktails manageable by a host. Built with React and Django REST API.

Notifications You must be signed in to change notification settings

Akwd22/shaker-magique

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Shaker Magique

Table of Contents
  1. About The Project
  2. Context
  3. Built With
  4. Documentation
  5. Getting Started
  6. License
  7. Contributors
  8. Acknowledgments

About The Project


This project is called Shaker Magique, the principle is simple: a website offering users a list of cocktails manageable by a host (e.g. a party host).

There are three categories of users:

  • The guest, who is not connected: he has only a few possibilities, he can join a host (a host is a user, who proposes cocktail recipes), in order to see the cocktails that this host proposes, or to consult among the list of all the cocktails independently of the host.
  • The member has an account: he has the same possibilities as the guest, but he can become a host and create his own list of cocktails and manage his ingredient stock to propose to other users, only available cocktails.
  • The admin : he has access to the administration panel. From it, he can consult the list of cocktails where he can manage all the cocktails of the website. Also, he has access to the list of all the ingredients and can manage them.

The usefulness of the site lies in the possibility of proposing its own list of cocktails to its friends during parties for example, according to the ingredients that the organizer of the party (host) has in stock. Because yes, if you propose a cocktail in your menu, but you don't have all the ingredients to make it, then it won't appear, unless you check the ad hoc filter.

Features

  • Find cocktail recipes with various search filters.
  • Join a party host to view their list of available cocktails.
  • As a party host, manage your cocktail recipes and your ingredient stock.
  • Rate out of 5 stars the cocktail recipes.

(back to top)

Context

This project is an academic project made during the second year in the University and Technological Institute (IUT) of Computer Science. Note that this project was not only an academic project, but also a request for a real use for a professor.

The development was done in a team of 6 people.

(back to top)

Built With

Front-End

Back-End

(back to top)

Documentation

You can find documentation files such as the requirements analysis, technical details, and UML diagrams in the folder docs/.

(back to top)

Getting Started

To get a local copy up and running follow the steps described in the document docs/manuel-utilisation.pdf at section III - Guide d'installation de l'application.

(back to top)

License

This project was made for a client. As such, the various elements used in this project belong to their respective owners.

(back to top)

Contributors

This project was made primarily by:

(back to top)

Acknowledgments

(back to top)