travellingprog / collatz-app

The website for the Collatz Loops application

Collatz Loops

About

This is the code behind the website https://www.collatzloops.com. The website creates numerical sequences that loop similarly to the Collatz Conjecture. The algorithm to derive these "loops" was created by Viktor Zivojinovic as a Python script. For the purpose of this website, that script was translated into a Typescript equivalent that can run on the front-end.

The source code has been made open-source to serve as a portfolio project for the developer, Erick Cardenas Mendez.

Running For Development

Prerequisites:

• FNM (or alternatively NVM) for Node version management
• pnpm

Once the prerequisites are installed:

1. Install the Node version specified in .nvmrc:

   fnm install

2. Install project dependencies:

   pnpm install

3. Run the development server

   pnpm run dev

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

Other Development Scripts

pnpm run build: Build out the website as a static site (Next.js docs).

pnpm run prettier: Auto-format the source code using Prettier.

pnpm run lint: Check for linting errors, as defined by the ESLint configuration.

pnpm run test: Run the Jest tests under watch mode.

Tech Stack

The following languages/libraries/frameworks were used in the creation of this application.

• Typescript
• React
• Next.js
• MaterialUI
• Math.js
• Jest