NibiJS Template

Nibi JS template build with Next, React, Cosmos-kit & tailwind to superstart your development.

Table of Contents

• Usage Instructions
  • Install Node Version Manager (nvm)
  • Run the application locally
• Dependencies
• Source (src) Directory Structure
• Deployments
• TSConfig

---

Usage Instructions

Install Node Version Manager (nvm)

To install or update nvm, run the install script using the following command:

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

For more information, see github.com/nvm-sh/nvm.

Run the application locally

1. Move to the repo's node version as defined by the .nvmrc:

   nvm use

2. Install yarn and download package dependencies (can take ≈3 minutes):

   npm install -g yarn
   yarn # or: npm install

3. Run the application with:

    npm run dev   # defaults to http://localhost:3000
    # or
    yarn dev
    # or
    pnpm dev
    # or
    bun dev

   This will automatically open an interactive development environment with hot reloading, enabling you to edit files and see changes reflected in the running application.

   Open http://localhost:3000 with your browser to see the result.

   You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

---

Dependencies

• Nibi JS
• Next js
• React js
• Tailwind
• Cosmos-Kit

---

Source (src) Directory Structure

• components: Contains all reusable components.
• pages: A directory containing the page-level components. Each subdirectory of pages corresponds to a page in the application.
• layouts: For layout-based components like sidebars, navbars, containers, page headers, and page footers.
• hooks: For custom hooks.
• context: Contains logic related to the global Redux store.
• config: For custom types re-used in multiple places. A subdirectory or file named "types" exports local to a specific directory.
• style: For utility functions that didn't fit into other categories.

---

Deployments

After building, you can upload dist folder to a hosting service like Netlify

yarn build

Reference: https://create-react-app.dev/docs/deployment/

---

TSConfig

Visit https://aka.ms/tsconfig to read more about this file

---

© Nibi, Inc.