https://github.com/eguller/hntoplinks
hntoplinks
https://github.com/eguller/hntoplinks
Last synced: about 1 month ago
JSON representation
hntoplinks
- Host: GitHub
- URL: https://github.com/eguller/hntoplinks
- Owner: eguller
- License: mit
- Created: 2013-01-02T16:02:08.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T13:00:45.000Z (6 months ago)
- Last Synced: 2025-01-03T13:38:16.620Z (6 months ago)
- Language: Java
- Homepage: https://www.hntoplinks.com
- Size: 764 KB
- Stars: 33
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- alternative-front-ends - HNTopLinks
README
# HN Top Links
A modern interface for browsing top stories from Hacker News, organized by different time periods. Similar to Reddit's "Top" feature, HN Top Links aggregates stories by daily, weekly, monthly and yearly intervals, letting you discover the most engaging content based on either upvotes or number of comments.
## Features
- Browse top stories by different time periods:
- Today's best
- Weekly digest
- Monthly highlights
- Yearly favorites
- All-time best
- Sort stories by:
- Most upvoted
- Most commented
- Email subscription options:
- Daily updates
- Weekly digest
- Monthly roundup
- Yearly review
- Complete archive access back to 2006
- Mobile-friendly responsive design
## Tech Stack
- Backend
- Java 17
- Spring Boot
- PostgreSQL
- Flyway (migrations)
- Frontend
- Thymeleaf
- Modern responsive CSS
- Infrastructure
- Docker
- GitHub Actions
## Local Development Setup
1. Prerequisites:
- Java 17
- PostgreSQL 13+
- Docker (optional)
2. Clone repository:
```bash
git clone https://github.com/eguller/hntoplinks.git
cd hntoplinks
```
3. Configure database:
```properties
# application-local.properties
spring.datasource.url=jdbc:postgresql://localhost:5432/hntoplinks
spring.datasource.username=your_username
spring.datasource.password=your_password
```
4. Run application:
```bash
./gradlew bootRun --args='--spring.profiles.active=local'
```
5. Access application at http://localhost:8066
## Testing
Run tests:
```bash
./gradlew test
```
Integration tests use TestContainers to spin up a PostgreSQL instance.
## Deployment
Using Docker:
```bash
docker-compose up -d
```
## Contributing
Contributions are welcome! Please:
1. Fork the repository
2. Create a feature branch
3. Add tests for new functionality
4. Ensure all tests pass
5. Submit a pull request
## License
This project is licensed under MIT License - see the LICENSE file for details.
## Acknowledgments
Inspired by Reddit's "Top" feature and built with data from Hacker News. Thanks to Y Combinator for providing the HN API.