Instructions for Frontend Team collaborators 🥷

This app is build with Reactjs which is a JavaScript library for building user interfaces. React makes it painless to create interactive UIs. Design simple views for each state in your application, and React will efficiently update and render just the right components when your data changes. Readmore...

Technologies and Dependecies

• React: (v ^18.0.0) a JavaScript library for building user interfaces. React makes it painless to create interactive UIs.
• plotly.js: (v ^2.12.1) Through a couple of simple patterns, It abstracts away all of the technologies and protocols that are required to build a full-stack web app with interactive data visualization.
• mathjs: (v ^10.5.1) Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types like numbers, big numbers, complex numbers, fractions, units, and matrices. Powerful and easy to use.
• axios: (v ^0.26.1) Axios is a simple promise based HTTP client for the browser and node.js. Axios provides a simple to use library in a small package with a very extensible interface.
• Other dependencies are found at ./Frontend/requirements.txt

Installation

• Check if you have installed the following tools' latest updates ✈️

1. Nodejs
2. npm

• You can check if you have these tools installed by going to your terminal and running the following commands:

    $ node -v

    $ npm -v

• Important: you must have the latest updates of these tools to run the app. if not please update to the latest versions

• Use Git to clone the repository in a location on your machine 🍎

    $ git clone https://github.com/mathemagic-art/Frontend-React.git

    $ cd Frontend-React

• Make sure you are in the correct location in the terminal: inside the Frontend folder if not cd to this location: then run the following command to install all the dependencies

    $ npm install

• This command should install all the dependencies needed to run react app, if you get any error in this step means you have some problem with the Nodejs version or npm please check those and try again.

• After installing all the dependencies you must be ready to Start: run the following command to open the app in localhost 3000 in your default browser 🍎

    $ npm start

• If you get any error in this step please read the error message in the terminal or console of your browser and try to resolve it by provided guidelines: if you couldn't figure it out, run the following command to audit it automatically:

    $ npm run audit

Or you can use a forced flag if a normal case wouldn't work

    $ npm run audit -f

• Then try to run the

  $ npm start

command again. This will hopefully work.

How to Contribute: Git Conventions 🕵️‍♀️

How to use git 😋

• You can work on the assigned component or feature and use the following steps to push your code to the repo

  $ git add "name of the file or all"

  $ git commit -m "message of commit: please read the guidelines for commit message"

  $ git push

Git commit message guidelines 🔔

Use the following keywords in each case for better readability 🐒

• "added: if you have created a new component or layout or page write the name here"
• "updated: if you have added or removed features to a component write the name of comp"
• "fixed: if you have fixed a bug, write the name of comp and bug type here"
• "deleted: if you have deleted any comp or feature or page write the name here"

Please strictly follow the guidelines on the commit message so we will have a fun collaboration" _ Nazari

stay sharp and motivated and enjoy coding with us 😇 ✊‍

MathMagics Frontend Team Forever 🤘