PercyPham / wedvn

Wed.vn helps spouses-to-be to connect with web designers, who can make beautiful presentations for their wedding.

Wed.vn

Wed.vn helps spouses-to-be to connect with web designers, who can make beautiful presentations for their wedding.

Setup Coding Environment

Environment

Must install:

• Docker (mac or window)
• Node (version >=12.8.1 <13.0.0)
• Git

Note: recommend using nvm to easily switch between node versions.

IDE

Use VSCode to develop this project.

Install these extensions to VSCode:

• npm
• Docker
• Eslint
• Prettier - Code formatter
• GitLens - Git supercharged

Open new workspace with file wedvn.code-workspace located in root of project. After that, tell git to ignore all changes in this file from now on:

# Tell git you want your own independent version of the file
git update-index --skip-worktree wedvn.code-workspace

Develop Project

Clone project:

git clone [e-mail]:PercyPham/wedvn.git wedvn

Install dependencies:

cd wedvn
cd server && npm install && cd ..

Run Dev environment:

# on Mac or Linux
./dev.sh

# on Windows
dev

If there are changes in source code and dev command doesn't affect. Example: changes in server/package.json.
Add --build to rebuild docker images:

# on Mac or Linux
./dev.sh --build

# on Windows
dev --build

Interact with running docker container in dev time:
Get the name shown in dev terminal (ex: wedvn-server_1). Open new terminal and run:

# on Mac or Linux
./interact.sh <shown-name>

# on Windows
interact <shown-name>

• Example (terminal): ./interact.sh wedvn-server_1
• Exit out of interaction: exit

Clean after a development session:

# on Mac or Linux
./clean.sh

# on Windows
clean

Conventions

Commit Message

This project follows Conventional Commits to make commit messages.

To comprehense it easily, here are some examples from Semantic Commit Messages:

chore: add Oyster build script
docs: explain hat wobble
feat: add beta sequence
fix: remove broken confirmation message
refactor: share logic between 4d3d3d3 and flarhgunnstow
style: convert tabs to spaces
test: ensure Tayne retains clothing