/JASHA

Jasha is web platform for raising awareness among the youth in Central Asia about conscious life.

Primary LanguageJavaScript

Instructions for JASHA Team collaborators 🥷🥷🥷

1) Setting Up React APP and clone Repo 🐈🐈

2) How to contribute to the repo: git conventions 💡

1) The following instruction is necessary to follow to run React App in your Machine 🍎

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

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:

  • Nodejs: node -v or node --version
  • npm: npm -v or npm --version

!important: you must have the latest updates of these tools if not please update to the latest versions

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 go: 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 outrun 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 -f audit
  • then try to run the _ npm start _ command again and this time it will work hopefully

2) 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 🔔🔔

  1. 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 😇 ✊‍

JASHA Team Forever :) 🤘‍🤘‍