Skip to content

DesignThinkerer/Scidelice

Repository files navigation

Scidelice

Scidélice is a progressive web application developed as part of my graduation project to obtain my bachelor's degree in computer graphics at the Haute Ecole en Hainaut.

Its goal is to assist users in learning how to cook and plan their meals according to their nutritional needs and preferences. The application provides information on the calories and nutrients of recipes, enables users to create their own recipes, and offers personalized suggestions based on their goals and preferences. Additionally, it includes articles that provide culinary and dietary information. Scidélice is developed using Angular, Ionic, and TiddlyWiki for prototyping purposes.

Diagram

erDiagram
    User {
        string Name
    }
    Recipe {
        string RecipeId PK
        string Title
        string Description
        string Instructions
        string ImageUrl
    }
    Ingredient {
        string IngredientId PK
        string Name
        string Quantity
        string RecipeId FK
    }
    Category {
        string CategoryId PK
        string Name
    }
    RecipeCategory {
        string RecipeId PK, FK
        string CategoryId PK, FK
    }
Loading

Features

  • Recipe Database: Scidélice integrates with the Open Food Facts database to retrieve nutritional information for recipes.
  • Recipe Creation: Users can create and save their own recipes within the application.
  • Personalized Suggestions: The application offers recipe suggestions tailored to the user's goals and preferences.
  • Culinary and Dietary Articles: Scidélice includes articles providing information on various culinary and dietary topics.

Project Structure

This repository contains the source code and documentation for the Scidélice project, organized into the following directories:

  • documentation/: general documentation files, such as specifications, diagrams, etc.
  • development/: source code of the application.
  • resources/: project resources, such as images or data files.
  • reports/: reports written throughout the project.
  • screenshots/: screenshots illustrating the interface and features of the application.

Technologies Used

  • Tiddlywiki: Used for prototyping and documentation purposes during the initial stages of development. It provided a convenient way to create a functional prototype and gather feedback before transitioning to Angular and Ionic for the full-fledged development.
  • Angular: The application is built using the Angular framework, providing a robust and scalable architecture.
  • Ionic: Ionic is used for the UI components and mobile app development capabilities.
  • Open Food Facts API: Scidélice integrates with the Open Food Facts API to retrieve nutritional information for recipes.
  • HTML/CSS/JavaScript: These core web technologies are used for implementing the user interface and application logic.

How to contribute

If you want to contribute to this project, you can check the list of open issues to see what tasks are available. Feel free to add comments, suggestions or submit pull requests to suggest improvements.

License

This project is licensed under the MIT License.

Contact

For any inquiries or feedback, please contact the project maintainer at theophiledesmedt@gmail.com.

Thank you for your interest in Scidélice!