torries123 / pn-server

testdevops

pn-server

Getting Started ✨

Installation

 npm i

Environment Variables

Add a file named .env at the root directory which is same level as package.json you can find SECRET in the Notion, copy paste them into .env file. Notion

Running the app

npm run start

Project Tech Stack

Back-end

• Node Version: v16 • Framework: Express.js • Scripting Language: Typescript • Testing: Jest, Supertest • Code Control: Eslint, Prettier • Git Hook: Husky, commitlint • Database: MongoDB • Object Modelling Tool: Mongoose • Cloud database service: MongoDB Atlas

Notion Board

We put our ticket board and other important information in the notion board. Notion

Code of Conduct 📋

1. Creating New Branches

Warning:heavy_exclamation_mark::cop:: No one was allowed to manipulate main branch directly in any way and for any reason. When you get a new ticket and plan to start your work, please create a new branch then start coding. You can create a pull request to make your work able to be reviewed and tested by team and get your code merged after getting enough approvals. Branch Name Example: "feature/pn-0027-a-user-can-view-profile" Tutorial about branch management: Link It is better to delete your branch after your pull request is approved and your branch have been merged into main branch.

2. Commit Message

Semantic Commit Messages See how a minor change to your commit message style can make you a better programmer. Format: <type>(<scope>): <subject> <scope> is optional Example feat: add hat wobble ^--^ ^------------^ | | | +-> Summary in present tense. | +-------> Type: chore, docs, feat, fix, refactor, style, or test. More Examples: feat: (new feature for the user, not a new feature for build script) fix: (bug fix for the user, not a fix to a build script) docs: (changes to the documentation) style: (formatting, missing semi colons, etc; no production code change) refactor: (refactoring production code, eg. renaming a variable) test: (adding missing tests, refactoring tests; no production code change) chore: (updating grunt tasks etc; no production code change) References: https://www.conventionalcommits.org/ http://karma-runner.github.io/1.0/dev/git-commit-msg.html

3. Pull Request

Pull Request Title Example: "Feature/pn 0042 a user can log in sign up"

4. Specific Code Convention

Basically we will use double double quotes ""instead of single quotes'' in the front end project. In terms of indentation, our indentation in the project is two spaces. How To Change Indentation in your VS code Please format your code before submitting your work.