Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 2.37 KB

Contributing Guideline

Welcome to the syhrimr/quickwasend 👋
Thanks for helping out this project!

Before creating your pull request, make sure you already read the whole guideline. If you feel that this guideline is not clear enough or have any doubts, feel free to raise it in the issues.

Project Structures

  • The /components stores reusable components JSX scripts.
  • The /data stores static JSON data.
  • The /hooks stores the hook functions.
  • The /network stores API request call functions.
  • The /pages stores the app pages.
  • The /utils stores reusable utility functions.

Used API

This app only request to one API endpoint of ipgregistry.co to get IP location data to validate your country phone number. For the rest, there is no API request to any server to store any phone number from your input.

Get location data

  GET /
Parameter Type Description
key string Required. Your API key from ipgregistry.co

Please place the API Key value in .env file.

Start Running in Local

Pre-requisites:

  • Since this project use NextJS 13, please use Node v14.x.x or higher.

Steps:

  1. After cloning this repository, please run package installation.
  npm install
  # or
  yarn install
  # or
  pnpm install
  1. Ensure to have an .env file with NEXT_PUBLIC_API_KEY before running the project (refer to User API to get the value).
  2. Run the project locally.
  npm run dev
  # or
  yarn dev
  # or
  pnpm dev

Sending Pull Request(s)

Since this project has pre-commit configuration with ESLint, Prettier, and TypeScript rules, please to check your code convention before committing.

You can run this command below to check your code:

  npm run check-all
  # or
  yarn check-all
  # or
  pnpm check-all

As we want to have standardize commit messages, please follow this commit message convention guide and 50/72 commit message rule format.