docs: adds development guide (#8)

* docs: adds development guide

* docs: adds a note

---------

Co-authored-by: Kevin Hermawan <[email protected]>

.github/workflows/code-quality.yml

@@ -51,5 +51,5 @@ jobs:
       - name: Install dependencies
         run: npm install
 
-      - name: Build package
-        run: npm run build
+      - name: Build packages
+        run: npm run build:packages

.github/workflows/release.yml

@@ -23,8 +23,8 @@ jobs:
       - name: Install dependencies
         run: npm install
 
-      - name: Build package
-        run: npm run build
+      - name: Build packages
+        run: npm run build:packages
 
       - name: Release @hyperjumptech/react-next-pathname
         run: npm publish --provenance --access public

README.md

@@ -116,6 +116,28 @@ const Sidebar = () => {
 
 Currently, the `@hyperjumptech/react-next-pathname-nextjs` package only supports the Page Router. If you are using the App Router, you can use the `@hyperjumptech/react-next-pathname` package. However, please note that it is not fully optimized for the App Router.
 
+## Development Guide
+
+If this is the first time you have cloned the repository, run the following commands:
+
+```bash
+npm install
+npm run build:packages
+```
+
+If you want to run the example, navigate to the example app directory and run the development server:
+
+```bash
+cd apps/example-nextjs
+npm run dev
+```
+
+Every time you make changes in packages and want to see them in the example app, you need to run:
+
+```bash
+npm run build:packages
+```
+
 ## License
 
 [MIT License](/LICENSE)

apps/example-nextjs/src/components/navbar.tsx

@@ -1,4 +1,4 @@
-import { useNextPathname } from "../../../../packages/react-next-pathname-nextjs/dist/index.mjs";
+import { useNextPathname } from "@hyperjumptech/react-next-pathname-nextjs";
 import Link from "next/link";
 
 const tabs = [

apps/example-nextjs/src/pages/_app.tsx

@@ -1,7 +1,7 @@
 import "~/styles/globals.css";
 
 import type { AppProps } from "next/app";
-import { NextPathnameProvider } from "../../../../packages/react-next-pathname-nextjs/dist/index.mjs";
+import { NextPathnameProvider } from "@hyperjumptech/react-next-pathname-nextjs";
 import Navbar from "~/components/navbar";
 
 export default function App({ Component, pageProps }: AppProps) {

package.json

@@ -2,7 +2,8 @@
   "name": "react-next-pathname",
   "private": true,
   "scripts": {
-    "build": "turbo build",
+    "build:packages": "turbo run build --filter=@hyperjumptech/*",
+    "build:apps": "turbo run build --filter=example-*",
     "lint": "turbo lint",
     "test": "turbo test",
     "test:coverage": "turbo test:coverage"