Interactive Kabbalah

Tech Stack

• React v18 - A JavaScript library for building user interfaces.
• Next.js v14 - A framework that simplifies React development with built-in routing and server-side rendering.
• TypeScript v5.5 - A typed version of JavaScript that helps improve code safety.
• Storybook v8.2 - A tool for developing and testing UI components in isolation.
• Jest v29 - A testing framework to ensure your code works as expected.

Minimum requirements

• Node v20 - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine.

tip: try use a Node Version Manager like nvm

What You Need to Know Before Starting

1. Node.js and npm

Node.js is a runtime that allows you to execute JavaScript outside of the browser. It comes with npm (Node Package Manager), which handles the project’s libraries and dependencies.

2. Yarn (npm Alternative)

Yarn is an alternative to npm for managing packages and dependencies. You can think of npm and yarn as equivalent to package managers like pip (Python) or Maven (Java).

Prerequisites

1. Install Node.js: You’ll need Node.js installed on your system to run this project. Download the latest version from the official Node.js website. During installation, npm will be installed automatically.

   Verify that Node.js is installed correctly by running the following command in your terminal:

   node -v

   This should output the version of Node.js installed.

2. Install Yarn (Optional): You can use either npm or yarn to manage dependencies. If you prefer to use yarn, install it globally with:

   npm install -g yarn

   Verify the installation with:

   yarn -v

Initializing the Project

1. Installing Dependencies

Similar to other languages, this project relies on various external libraries (called dependencies). To install them, follow the steps below in your terminal, inside the project folder.

If using npm:

npm install

Or, if using yarn:

yarn

2. Running the Development Server

This project uses Next.js, which includes a built-in development server. To start the server and view the application in your browser, use the following command:

If using npm:

npm run dev

Or, if using yarn:

yarn dev

This will start the local server, and you can access the application at http://localhost:3000 in your browser.

3. Building for Production

Before deploying the application, you need to compile it for production. This process creates an optimized set of files that can be served by a web server.

If using npm:

npm run build
npm start

Or, if using yarn:

yarn build
yarn start

4. Using Storybook

Storybook is a tool that allows you to build and test UI components in isolation. To run Storybook, use the following commands:

If using npm:

npm run build-storybook
npm run storybook

Or, if using yarn:

yarn build-storybook
yarn storybook

This will launch Storybook in the browser, where you can interact with the UI components independently from the main application.

Troubleshooting

Node.js Not Installed?

Ensure that Node.js is installed by running:

node -v

If you see an error, it means Node.js is not installed. Download and install the latest version from the official Node.js website.

Command yarn Not Found?

If you prefer to use yarn and encounter the error command not found: yarn, install it globally by running:

npm install -g yarn

Then, try running the commands with yarn again.

Additional Resources

• Next.js Documentation - Learn more about Next.js.
• Storybook Documentation - Discover how to use Storybook.
• Jest Documentation - Get started with Jest for testing.