Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michaelbull/aurelia-hacker-news

A recreation of the Hacker News website written in TypeScript and built with Aurelia.
https://github.com/michaelbull/aurelia-hacker-news

aurelia firebase hacker-news hackernews hackernews-clone typescript webpack

Last synced: about 2 months ago
JSON representation

A recreation of the Hacker News website written in TypeScript and built with Aurelia.

Host: GitHub
URL: https://github.com/michaelbull/aurelia-hacker-news
Owner: michaelbull
License: isc
Created: 2016-11-25T21:34:29.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2020-08-25T22:00:07.000Z (over 4 years ago)
Last Synced: 2024-05-12T22:34:48.749Z (8 months ago)
Topics: aurelia, firebase, hacker-news, hackernews, hackernews-clone, typescript, webpack
Language: TypeScript
Homepage: https://michaelbull.github.io/aurelia-hacker-news
Size: 2.49 MB
Stars: 62
Watchers: 6
Forks: 7
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

    

  





  A recreation of the Hacker News website written in TypeScript and built with Aurelia.





  Demo





    





  

    

  









## Features

- News list with filters for the

  [top][topstories]/[newest][newstories]/[best][beststories] stories.

- Topic view with collapsible comment threads.

- Responsive design for tablet and mobile platforms.

- User profile pages.

- Improved pagination.

## Components

- [Webpack][webpack] as the build system.

- [Aurelia][aurelia] as the client framework.

- [TypeScript][ts] as the primary programming language.

- [Sassy CSS][scss] as the stylesheet language, following the [7-1 pattern][7-1]

  and the [“Block Element Modifier” methodology][bem].

- [Firebase][firebase] as a data store for the [Hacker News API][hn-api].

## Building

The following scripts are configured to run via [npm][npm]:

- `npm start`

  - Runs the [webpack-dev-server][dev-server] at

    [`http://localhost:8080`][localhost]

- `npm run build`

  - Builds the production distribution and places it under the `./dist`

    directory.

- `npm run clean`

  - Cleans the `./dist` directory.

## Contributing

Bug reports and pull requests are welcome on [GitHub][github].

## License

This project is available under the terms of the ISC license. See the

[`LICENSE`](LICENSE) file for the copyright information and licensing terms.

[topstories]: https://michaelbull.github.io/aurelia-hacker-news/#/news

[newstories]: https://michaelbull.github.io/aurelia-hacker-news/#/newest

[beststories]: https://michaelbull.github.io/aurelia-hacker-news/#/best

[webpack]: https://webpack.github.io/

[aurelia]: https://aurelia.io/

[ts]: https://www.typescriptlang.org/

[scss]: http://sass-lang.com/

[7-1]: https://sass-guidelin.es/#the-7-1-pattern

[bem]: http://getbem.com/

[firebase]: https://www.npmjs.com/package/firebase

[hn-api]: https://github.com/HackerNews/API

[npm]: https://www.npmjs.com/

[dev-server]: https://github.com/webpack/webpack-dev-server

[localhost]: http://localhost:8080

[github]: https://github.com/michaelbull/aurelia-hacker-news