Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 4.84 KB

README.md

File metadata and controls

89 lines (62 loc) · 4.84 KB
Raw

Image text

💡 WeCheck is a rubric system for the critical evaluation of interfaces, this idea was developed by a research group from the Universitat Oberta de Catalunya. Different evaluators can review web pages and score them using this system. The client needs a website where these rubrics can be entered, so that registered or unregistered users can evaluate websites and obtain a visual result of the evaluations, by evaluator and by average.

Demo & design 📱

  • The Figma design can be found here.

demo

Technologies used ⚙️

  • React - a JavaScript library used for building user interfaces and web applications
  • Tailwind CSS - a utility-first CSS framework used for styling web pages
  • SweetAlert 2 - a JavaScript library used for creating alert dialogs
  • Laravel - a PHP web application framework used for building the back-end of web applications
  • MySQL - a relational database management system used for storing data
  • Vite - a build tool used for creating production-ready assets for web applications built with Laravel and React
  • Axios - a promise-based HTTP client used for making API requests from web applications
  • Cypress - a JavaScript end-to-end testing framework used for testing the front-end of web applications
  • PHPUnit - a unit testing framework for PHP used for testing the back-end of web applications.

Tools used ⚙️

  • Git - Version control system for tracking code changes and team collaboration. Used for codebase version control.
  • GitHub - Web-based Git repository hosting service for version control and team collaboration. Used for hosting and managing Git repositories.
  • PhpMyAdmin - Open-source web-based tool for managing and administering MySQL databases. Used for interacting with MySQL databases.
  • Visual Studio Code - Source-code editor developed by Microsoft used for writing and editing code. Used as the primary code editor.
  • Trello - Web-based project management tool for organizing and managing tasks and projects. Used for project management and team collaboration.
  • Figma - Web-based tool for designing user interfaces and web applications. Used for creating design mockups and wireframes.
  • MAMP/XAMPP - Local server environments for developing and testing web applications. Used for testing web applications locally before deployment.
  • Postman - Collaboration platform for API development used for designing, testing, and documenting APIs. Used for testing and debugging APIs.

How to Run 🧑‍🔧

git clone https://github.com/Rubrics-project/WeCheckUx.git

Front-end

  • First, in the project directory, run cd react and, after that, run npm install
  • Then, in the project directory (react/ folder), run npm run dev
  • The page will reload when you make changes.
    You may also see any lint errors in the console.
  • Open a web browser and navigate to http://localhost:3000 to see the website.

Back-end

  • Run another terminal, go to the backend folder running cd backend
  • Run composer install
  • Run php artisan serve
  • Run the development server with Xamp or Mamp

Contributors 👩‍👩‍👧‍👧

Contributing Guidelines

We appreciate your interest in contributing to our project! Before you get started, please read the following guidelines to ensure that your contributions align with our project's goals and standards.

Code of Conduct

We expect all contributors to adhere to our code of conduct. Please review it before making any contributions.

How to Contribute

  1. Fork the repository
  2. Clone the forked repository to your local machine
  3. Create a new branch for your changes
  4. Make your changes and commit them with descriptive commit messages
  5. Push your changes to your forked repository
  6. Submit a pull request to the original repository

Pull Request Guidelines

When submitting a pull request, please ensure that:

  • Your changes do not conflict with the main branch
  • Your code follows our project's style and formatting guidelines
  • Your code passes all tests and does not introduce any new issues
  • Your pull request includes a description of the changes you made and why they are necessary or beneficial

Thank you for considering contributing to our project! We look forward to reviewing your contributions.

Enjoy WeCheck!