Overview
This product is a clone of Hacker News written in TypeScript using Remix and React. It serves as an example or boilerplate to help structure projects using production-ready technologies. The project implements the publicly available parts of the Hacker News site API, with some remaining functionality implemented in-memory.
Features
- Remix (Server side rendering framework)
- React (Declarative UI)
- ESBuild (via Remix, sub-second production builds)
- TypeScript (Static typing)
- ESLint (Code checking)
- Authentication via Cookies (plain JS)
- Jest (Test runner)
- Prettier (Code formatter)
- Docker (Container builder)
Installation
To install the theme, follow these steps:
- Clone the repository:
git clone https://github.com/clintonwoo/hackernews-remix-react.git
- Navigate to the cloned directory:
cd hackernews-remix-react
- Install the required dependencies:
npm install
- Build and start the project with file watching:
npm run dev
or 5. Perform a regular build and start the project:
npm run build
npm run start
Summary
This product is a clone of Hacker News written in TypeScript using Remix and React. It provides a powerful and efficient way to structure projects using modern and production-ready technologies. With features such as server-side rendering, sub-second production builds, and code checking, it offers developers a solid foundation for building web applications. The installation process is straightforward, making it easy for developers to get started and customize the clone according to their needs.