Express API Project Workflow

Welcome to a guide on how you can structure your development process when building an Express API. Think of it like a well-organized roadmap—each feature has a predictable journey, from early planning (in the project board) to final deployment (merged into main), ensuring that you always have clear next steps and visible progress.

Creating Your Major Branches

It all starts with two essential branches:

• main – Represents your deployed, production-ready code.
• dev – The active development branch where new features are integrated and tested.

You’ll do most of your day-to-day work in dev. When a new feature is ready, it merges into dev. Once you (and your Project Manager) are satisfied with dev’s content, it can move to main and go live.

In your local git repository:

git checkout -b dev
// Make initial commits or push

From then on, every new feature should branch off from dev.

Select the Next Development Feature

Before you begin coding each new feature:

• Move the corresponding card in your Kanban board to In Progress.
• Confirm the tasks or checkboxes associated with that card, as these form the acceptance criteria.
• Optional: Move the next few items into Next Tasks, so everyone has a glimpse of what’s coming soon.

Having a clear visual of what’s planned, what’s in progress, and what’s done keeps everyone informed and helps you plan your day-to-day progress.

// from the dev branch:
git checkout dev
git checkout -b feature-name

Now you have a dedicated feature branch to make commits for that task.

Develop the Feature

Write your code, implement endpoints, run tests—this is the coding phase. Make commits as you reach logical milestones:

git add someFile.js
git commit -m "Implement basic route logic"

If you want to push your branch to GitHub (for backup or collaboration):

git push -u origin feature-name

This is optional if you’re working solo, but it’s good practice and critical in a team environment.

Merge and Push the dev Branch

Once the feature is working locally and meets the requirements on the Kanban card, it’s time to incorporate it into dev:

git checkout dev
git merge feature-name

This pulls all commits from feature-name into your dev branch. If there are conflicts, resolve them, commit the resolution, and proceed.

With the feature merged into dev, push your updated dev:

git push origin dev

Now your dev branch on GitHub includes the new feature, ready for review.

Create a Pull Request

Your Project Manager needs to review your new functionality. A Pull Request (PR) merges dev into main on GitHub. Steps:

1. Go to your repo on GitHub, click Pull requests, then New pull request.
2. Ensure the base is main (the branch we’re merging into) and the compare is dev (the branch containing new changes).
3. Add a descriptive title and a short summary of changes (bullet points often help).
4. Add your Project Manager as a reviewer, then Create pull request.

Move your card on the Kanban board to In Review. This signals that you’ve finished the development portion of the feature.

Continue Development on the Next Feature

While your PM reviews the PR, you don’t need to wait idly. Pick the next feature (move the corresponding card to In Progress), create a new branch from dev, and keep coding. This overlap helps keep you productive even as previous features await feedback.

Handle PR Review

Once your PM reviews your PR:

• If changes are requested: Checkout your feature branch again, fix or update the code, commit, merge into dev, push, and it’ll automatically show up in the existing PR. Re-request a review.
• If approved: Your PM or you can press the Merge button on the pull request, merging dev’s commits into main.

After merging, deploy the updated main branch to your production environment. Finally, move the Kanban card to Accepted—success!

Tips and Notes

• Keep Feature Branches Updated: If dev changes while you’re still building a feature, you can merge dev into your feature branch anytime to bring it up to date.
• Pull from Remote Frequently: If you’re collaborating or making changes directly on GitHub, use git pull on your local branch to sync up changes.
• Kanban Board: Always keep it updated! During standups or planning sessions, you and your PM can see at a glance what’s done, what’s in progress, and what’s up next.
• Communicate with Your PM: If your workflow needs adjustments or special cases arise (urgent fixes, rewriting dev or main, etc.), consult them.

What You’ve Learned

By following this consistent workflow, you’ll streamline feature development, testing, and review cycles. Remember these key steps:

1. Branch off dev for each feature.
2. Keep your Kanban board in sync, moving cards as they progress.
3. Merge feature branches back into dev and create a pull request to merge dev into main.
4. Review and deploy once approved.

This approach helps ensure each feature is properly tracked, reviewed, and integrated without disrupting other parts of the system. Embrace this process, and you’ll find your Express API project evolving smoothly, with fewer surprises and a clear record of changes along the way.