Skip to content

SuphawitCE/node-restapi

Repository files navigation

Talkgunmai API

API for social media Talkgunmai where users can signup and post their story, status, and upload image

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have a Mac / Linux Workstation.
  • You have installed the following software:
    • Node (14.x or above)

Running Local Development

cd node-restapi
npm install
npm start

Environment Variables

  • MONGO_USERNAME: mongoDB username
  • MONGO_PASSWORD: mongoDB password

Conventional commit

<type>(<scope>): <description>

Since our JIRA does not yet integrate with our GitHub, it is needless to prefix your commit with JIRA's ticket.

Type

  • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).

  • feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).

  • refactor: a commit of the type refactor organizes a codebase without changing its logic.

  • chore: a commit of the type chore is the change that does not affect the meaning of the code (white-space, formatting, missing semi-colons, comments, etc)

  • docs: a commit of the type docs is for a documentation only changes i.e., update readme file.

  • ci: a commit of type ci changes CI configuration files and scripts.

  • build: a commit of the type build changes the build system or external dependencies (example scopes: gulp, broccoli, npm).

  • test: a commit of the type test adds the missing tests or correct the existing tests.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors