Home

Welcome to the data-collection-tool wiki!

Setup

• Clone this repo to your local machine
• Create a new file in the root directroy and name it .env
• Copy the contents of .env.example to the newly created file above.
• Run the command php artisan key:generate to get a new unique key
• Create a new database and name it datagrip. Once this is done and u've made the necessary changes to your .env file (if at all you need to add the database password and user) then you can run php artisan migrate --seed to scafold the necessary tables and create sample data to work with.

Programming Languages used

Laravel, Vuejs, HTML, CSS

Contributing

1. Run: git checkout master followed by git pull to update it with the lastest code.

2. All features have been listed in form of issue with a label feature. You can browse to issues and select a feature to work on or better yet you can create a new issue detailing what features you believe would be amazing to have.

3. Create your branch from master (keep it lower-slug-case) to work on an issue

   $ git checkout -b [branch-name]
   
   for example
   $ git checkout -b feat/users-accounts

4. You are free to make periodic commits along the branch life span.

   • git add . or git add -A
   • git commit -m "creates user account"
   • git push origin feat/user-accounts

5. When the feature is complete, write all possible tests and then squash your commits in preparation for a pull request.

   • User your branch to see how many commits u've made or u can check github and then run this command with your number of commits appended to it git rebase -i HEAD~7
   • It will open in vim, and you will press down-arrow to move to the second line.
   • Followed by SHIFT+V to enter visual line mode to highlight the second line.
   • Press down-arrow until you reach the last commit you want to squash.
     1. Press colon :
     2. Enter s/pick/s/
     3. Press Enter to squash the highlighted commits upwards
     4. Type :wq to write & quit vim

6. Update your local master branch Run: git checkout master && git pull

7. Rebase your branch on master: git checkout feat/user-accounts && git rebase master (fix any merge conflicts)

8. You can now push your branch back up and submit a pull request for review.

Resources

• Laravel Framework
• Vue

Features

To be populated with time