- Installing and Running the Application
- Contribution rules
- Server deployment and run
- Docker Development
1.1. Open the terminal, go to the folder where you want softrace-client repository to be installed and run:
git clone https://github.com/softrace-tech/surveil-web.git
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 surveil-web/ folder and run npm install or yarn install to install the dependencies of the application (one time activity)
1.5. Go to surveil-web/ folder and run ng serve, and your application shall start up on port 4200
2.1. Never work on master branch!
2.2. Always branch out the latest necessary code from development branch!
2.3. Once your PR is merged to development is merged, make sure to raise another PR from development to master
2.4. 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, release, hotfix)
💻 command: git checkout -b bugfix_FormatPostContent
- 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
2.5. Everyday BEFORE start working, pull the remote branch updates to your local branch.
💻 command: git checkout bugfix_FormatPostContent
... and run ...
💻 command: git pull
2.6. Everyday AFTER resume working, push your local branch updates to remote branch.
💻 command: git checkout bugfix_FormatPostContent
... and run ...
💻 command: git push
1.1. Checkout to development:
git checkout development
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 development
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!
Let people know you're opening this pull request.
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!
git checkout master
git pull
git checkout feature_ThatOldFeature
git pull
git checkout feature_ThatOldFeature
git rebase master
If there are 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!
git push