The Api is used to search assist you in remembering what to pack using Mock Json-server Api.
- Project lives at: ghum-gham.samresh.com.np
- JSON Server API at: JSON_SEVER_API
To get started with this project, follow the steps below:
-
Clone the repository: git clone https://github.com/username/repository.git
-
Install dependencies:
npm install
-
Start the project:
- For running in development mode :
npm run dev
https://ghumgham-api.onrender.com/items
Our project is automatically deployed on the Render platform. When you your pull request (PR) , it will trigger an automatic deployment on Render.
We utilize Husky, a Git hook tool, to enforce certain actions and maintain a consistent workflow within our project. Git hooks are scripts that run before or after specific Git events.
- Pre-commit Hook: We have setup the pre-commit hook that runs code formatting scripts and linters to ensure code consistency before committing changes.
Please ensure that your code meets the required standards and passes the necessary checks before committing or pushing changes.
Certain parts of our application require the presence of environment variables for proper configuration. These variables are typically stored in a .env
file at the root of the project.
Before running the project locally, make sure to create a .env
file and you can clone the sample.env
and fill your value accordingly. Log related configuration have default value, therefore do not require values from .env.
All environment values are consumed at config/default.js for centralized implementation.