https://github.com/harryhope/newshack
🗞💻 Just another hacker news client
https://github.com/harryhope/newshack
es6 hackernews-api react
Last synced: about 2 months ago
JSON representation
🗞💻 Just another hacker news client
- Host: GitHub
- URL: https://github.com/harryhope/newshack
- Owner: harryhope
- License: mit
- Created: 2019-01-16T04:10:40.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:05:57.000Z (almost 3 years ago)
- Last Synced: 2025-03-13T10:35:34.403Z (11 months ago)
- Topics: es6, hackernews-api, react
- Language: JavaScript
- Homepage: https://harryhope.github.io/newshack/
- Size: 3.04 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🗞 newshack 💻
Newshack is just another hacker news client. It's a single-page React application that reads from the [official HN API](https://github.com/HackerNews/API) and is designed to work right in [GitHub Pages](https://pages.github.com). I built it because I wanted a simple, aesthetically pleasing way to read [hacker news](https://news.ycombinator.com), especially on mobile.
[You can see it here.](https://harryhope.github.io/newshack)
## Screenshots
## Getting Started
Clone the repository and make sure you have `node` installed.
Run `npm i` to install dependencies.
To run a development server with hot module reloading type:
```
npm run dev
```
Once you run this command, Newshack will be available at `localhost:3000/newshack`. The app will hot reload in-browser as you save your changes.
To build and minify a production-ready version:
```
npm run build
```
## Testing
To run all lints and tests against the codebase, run:
```
npm test
```
ESLint can automatically fix certain linting issues with the command:
```
npm run lint:fix
```
If for some reason you need to only run jest tests, use:
```
npm run test:jest
```
## Profiling
For a visualization of the projects dependencies and their size (both uncompressed and gzipped), you can run:
```
npm run profile
```
This is a good way to understand the impact libraries have on file size and load time.
## Deploying
Newshack is designed to be deployed on [GitHub Pages](https://pages.github.com). The `gh-pages` branch of this repo contains built js checked in to the repo. To deploy, simply merge `master` into `gh-pages`, run `npm run build`, and then commit and push the changes from `gh-pages` to GitHub.