| CoffeeTrace App v.1

Welcome to CoffeeTrace dev team! 😀

Make sure to read all the guidelines before start working

| Index:

1. Installing and Running the Application
2. Contribution rules
3. Server deployment and run

1. Installing and Running The App On Your Machine

1.1. Open the terminal, go to the folder where you want coffee-trace repository to be installed and run: git clone https://github.com/agri-yoda/coffee-trace

1.2. Make sure you have nodejs installed in your system along with any package manager or your choice(npm or yarn)

1.3. Install Angular Globally npm install -g @angular/cli or yarn global add @angular/cli, if not done already

1.4. Go to coffee-trace/client folder and run npm install or yarn install to install the dependencies of the application (one time activity)

1.5. Go to coffee-trace/server folder and run npm install or yarn install to install the dependencies of the application (one time activity)

1.5. Go to coffee-trace/client folder and run ng serve, and your application shall start up on port 4200

1.6. Fire up a new terminal and go to coffee-trace/server and run npn run dev or yarn run dev, and your server application shall start up on port 3000

---

2. Contribution Rules

Never work on master branch!

Create a new branch for each set of related bugs or set of related tasks, naming by:

type_CapitalizedName, example: bugfix_EditPostContent.

(types: bugfix, feature)

💻 command: git checkout -b bugfix_FormatPostContent

⚠️ Important:

• Before creating a branch, check if someone already started to work on this task and if there's already a branch created for this task, and if there is, please fetch the branch with the command:

💻 command: git fetch origin bugfix_FormaPostContent:bugfix_FormatPostContent

• Right after creating a new branch, push it to remote to make it available for everyone, defining the upstream.

💻 command: git push -u origin bugfix_FormatPostContent

Everyday BEFORE start working, pull the remote branch updates to your local branch.

⚠️ Important: make sure you're on the correct branch...

💻 command: git checkout bugfix_FormatPostContent

... and run ...

💻 command: git pull

Everyday AFTER resume working, push your local branch updates to remote branch.

⚠️ Important: make sure you're on the correct branch...

💻 command: git checkout bugfix_FormatPostContent

... and run ...

💻 command: git push

"... Ok! ... I've finished the task, what now? ..."

⚠️ ...Please follow these rules to have your work ready to deploy:

1. Update your local master branch and rebase the branch you was working:

1.1. Checkout to master:

git checkout master

1.2. Pull the updates:

git pull

1.3. Checkout to the branch you was working on:

git checkout bugfix_FormatPostContent

1.4. Rebase this branch:

git rebase master

⚠️ Important:

If there are more people working on this branch, let them know you're rebasing.

Conflicts may occur, and it must be resolved on this branch!

The developer is responsible to resolve conflicts and test it on the current branch to make sure the branch is ready and safe to be merged!

2. Test the app and start your work again!

3. Go to GitHub and open a Pull Request, the admin will finish the job!

⚠️ Important:

Let people know you're opening this pull request.

⚠️ Tip:

If you finished working on this branch forever, and you've noticed that the branch was already closed on remote, it makes sense to delete this branch locally:

git branch -d bugfix_FormatPostContent

Are you going back to work on a branch you've created some time ago? Let's make it ready to work again!

1. Make sure your master branch is updated:

git checkout master

git pull

2. Update this branch you're gonna work (someone could've been working on this branch):

git checkout feature_ThatOldFeature

git pull

3. Rebase the branch you're getting back to work:

git checkout feature_ThatOldFeature

git rebase master

⚠️ Important:

If there's more people working on this branch, let them know you're rebasing.

Conflicts may occur, and it must be resolved right now, before you get back working on the feature!

4. Push this updated branch state to remote:

git push

... and then you're good to go!

---