danielbrathwaite / ChefConnect

0 stars 0 forks source link

ChefConnect

ChefConnect

Table Of Contents

Sequence Diagrams for Authentication

UML Diagram

Contributing to ChefConnect

Sequence Diagrams for Authentication

https://www.figma.com/board/hAoqxbnJ5ubIZGkPl2w3VY/Authentication-sequence-diagram?node-id=0%3A1&t=r94iSdXCvnV2THBE-1

UML Diagram

https://github.com/danielbrathwaite/ChefConnect/blob/main/uml_diagram.md

Contributing to ChefConnect

:+1::tada: For starters, thank you for contributing! :tada::+1:

This section details the rules / guidelines for making contributions to ChefConnect, hosted at the ChefConnect Repo on GitHub. Please keep in mind, these are just guidelines, when in doubt defer to your best judgement or reach out to our team.

The Team

Manasa Srikanth, Joshua Cheruvelil, Sean Phun, Eyasu Betwos, Daniel Brathwaite

What should I know before I get started?

Setup and IDE Plugins

Currently no IDE plugins are necessary to host ChefConnect locally. There are, however some useful tools that can streamline your development process. For example, setting up VSCode with Prettier will help you automatically format your code correctly. Past that, you can check out the NPM dependencies you'll need by checking the top and sub-level package.json files in the ChefConnect repo.

Running Cypress Tests

To run cypress tests in browser, do:

npm run cy:open

To run cypress tests without UI, do:

npm run cy:run

Coding Standards

This project and everyone participating in it is expected to operate with positive intentions. Our mission is to bring together people with a love of the culinary arts and people who enjoy a good meal. Any malicious and / or unsafe coding practices are strictly prohibited. Violation of this principle will result in a complete and immediate ban from all ChefConnect affiliations.

Styleguides

JavaScript Formatting Styleguide

All JavaScript code is linted with Prettier.

Coding Style Guides by Language