Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 1.6 KB

README.md

File metadata and controls

77 lines (48 loc) · 1.6 KB
Raw

LogoPassaFun

PassaFun is a dynamic frontend platform that adapts to customizable game settings and content provided by the backend.

Run Locally

Clone the project

  git clone https://github.com/passafund-team-passionate/PassaFun.git

Go to the project directory

  cd PassaFun

Install dependencies

  npm install

Start the server

  npm run dev

File Naming Conventions

  • File Names

    • Convention: Pascal Case
    • Example: HomePage

  • Folder Names

    • Convention: Lowercase
    • Example: pages

  • Class Attribute Styling and Branch Names

    • Convention: Kebab-case
    • Example: navbar-button
    • Example: feat/recipe-calculator

  • Functions / Variables

    • Convention: CamelCase
    • Example: submitForm

Commit Message Conventions

To keep our commit history clear and organized, use the following types for your commit messages:

  • feat: For adding new features.

    • Example: feat: add user login page

  • fix: For fixing bugs.

    • Example: fix: correct signup form validation error

  • docs: For updating documentation.

    • Example: docs: add setup instructions to README

  • refactor: For changes that improve the code without adding features or fixing bugs.

    • Example: refactor: clean up code in user profile component

Authors