Skip to content

Latest commit

 

History

History
32 lines (27 loc) · 2.24 KB

guidelines.md

File metadata and controls

32 lines (27 loc) · 2.24 KB
Raw

Guidelines for contributing to SharedRecipe

Missions of SharedRecipe

  • SharedRecipe development team promises to serve a safe and accessible web application experience to every user.
  • SharedRecipe welcomes anyone who wants to share their passion in food and cooking with the others.
  • SharedRecipe does not accept discriminated content of any form, for example: hatred, racism, etc.

Development Team

  • The development team is an open-minded community which emphasizes on freedom of ideas and collaboration.
  • Every member of the development team is responsible to support one another in a positive manner.

Fundamental steps to start contributing to SharedRecipe

  • fork the main branch of SharedRecipe_app repository guide
  • install node v18.17.0 and npm v9.6.7 (using nvm is recommended) guide
  • run npm install in the root directory of the project to download the project dependencies
  • install the latest version of the Firebase command line tools guide
  • change the value of usingEmulators on line 39 to true in lib/firebase.ts
  • run firebase init emulators to setup Firebase emulators for auth, functions, firestore, and storage guide
  • run firebase emulators:start --only firestore,storage,auth,functions to start developing locally with Firebase
  • run npm run dev to serve the application on your localhost (port 5173)
  • once the contribution is completed, submit a pull request to the SharedRecipe_app repository

Related Tool Documentations

Mischievous Action

The infrastructure of this application is tied to the account belonged to Natdanai (Next) Ongarjvaja, "NextZtepS."
With that being said, any deleterious action caused by mistake or any other means shall be prone to a direct lost of benefit of the owner.
Anyone who intentionally causes deleterious action will be held responsible. Other minor mistakes with no negative intention shall be considered case by case.