devshelpdevs_webapp

Devshelpdevs web application for applicants and donors

To contribute to this project

1. Fork this repository

2. Open your command terminal

3. Type this following commands one after the other

   git clone https://github.com/devshelpdevs/webapp_v1.git
   
   cd webapp_v1
   
   yarn
   

4. You will notice you are on the (main) branch, do not start coding immediately. First create a new branch out of the main branch using the following commands

   NOTE * These are conventions for naming branches are

   • For new features use => "feature/your_username/feature-name"
   • For bug fix use => "bugfix/your_username/bug-name"
   • For hotfix use => "hotfix/your_username/hotfix-name"

   git checkout -b "your_new_branch_name"
   

5. Then you can start coding.

   • The controllers directory is where you write the business logic e.g authentication logic e.t.c
   • The routers directory is where you assign a endpoint for it.

6. When done, always first pull the latest changes and updates from the repository using git pull origin dev .

7. Stage your all changes using git add ..

8. Commit your changes using git commit -m "your commit message.

9. Push your code to github using git push -u origin "your_new_branch_name".

10. Make a pull request on github.

To run this project

RUN: yarn run dev

Then visit http://localhost:3000 to see it live.