https://github.com/maksimdrachov/hackernews-django
https://github.com/maksimdrachov/hackernews-django
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/maksimdrachov/hackernews-django
- Owner: maksimdrachov
- Created: 2022-06-12T12:06:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T10:01:36.000Z (almost 3 years ago)
- Last Synced: 2024-11-30T11:14:03.196Z (10 months ago)
- Language: Python
- Size: 39.1 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hackernews-django
## TODO
- [ ] implement upvote system
- [ ] upvote news articles
- [ ] upvote comments
- [ ] add points [algorithm](https://medium.com/hacking-and-gonzo/how-hacker-news-ranking-algorithm-works-1d9b0cf2c08d)
- [ ] if upvoted, `^` should be green
- [ ] tabbed reply comments
- [ ] study [Django-MPTT](https://django-mptt.readthedocs.io/en/latest/)
- [ ] data model update
- [ ] template update
- [ ] improve forms templating
- [ ] form label should be same style as nav bar
- [ ] inside personal profile:
- [ ] list: my news posts
- [ ] list: my events
- [ ] list: my jobs
- [ ] list: upvoted news
- [ ] list: upvoted comments
- reply should only work when logged in (LoginRequiredMixin)
- upvote button should do a post to increase count
- add link to other profiles to display posts,...
- news should display 10 items and have a page number changer at the bottom
- news: top, latest(->default, since at the beginning there wont be so many articles), hot
- check if everything works when not logged in (for example events page doesn't)
- jobs: add an external link to model
- add edit and delete functionality
events
- [x] add events model
- [x] add events calendar
accounts
- [ ] add account system
- [x] login
- [x] logout
- [x] register
- [ ] add email confirmation
- [ ] profile page content
- [ ] posted articles (news, events, jobs)
- [ ] upvoted articles
upvotes
- [ ] add upvote system
- [ ] points [algorithm](https://medium.com/hacking-and-gonzo/how-hacker-news-ranking-algorithm-works-1d9b0cf2c08d)
comments
- [ ] comments model
- [ ] comments templating
- [ ] [Django-MPTT](https://django-mptt.readthedocs.io/en/latest/)
styling
- [ ] design mascotte
- [ ] design sticker
- [ ] re-design favicon (estonian flag)
- [ ] improve styling calendar header
- [ ] set title limit for events
## Common Commands
Activate virtual environment: `source bin/activate`
Deactivate virtual environment: `deactivate`
Create admin: `python manage.py createsuperuser`
`python manage.py makemigrations`
`python manage.py migrate`
`python manage.py runserver`
## Code documentation
### NewsPost
> Each "News" post needs an entry in the database
```python
class NewsPost(models.Model):
title = models.CharField(max_length=100, blank=False)
url = models.URLField(max_length=300, blank=False)
domain = models.CharField(max_length=300, blank=False)
author = models.CharField(max_length=20, blank=False)
time = models.DateTimeField(auto_now_add=True, blank=False)
votes = models.IntegerField(default=0, blank=False)
```
- **title** `CharField`: A string field, contains the post's title
- `max_length=100`: sets the max length of the title to 100 characters
- `blank=False`: the field is not allowed to be blank/empty
- **url** `URLField`: A CharField for a URL, validated by URLValidator
- `max_length=300`: sets the max length
- `blank=False`: the field is not allowed to be blank/empty
- **domain** `CharField`: A CharField, contains the (shortened) domain name of the posted link (used for the news homepage), set automatically when a new post is submitted.
- **author** `CharField`
- contains the author username of the post (_should be changed to the username of the poster_)
- **time** `DateTimeField`
- timestamp when the post was made (date + time)
- `settings.py`: `TIME_ZONE = 'Europe/Tallinn'`
- sets correct timezone
- **votes** `IntegerField`
- number of upvotes, starts at 0
### JobPost
> Each "Job" post needs an entry in the database
`python manage.py startapp JobPost`
`models.py`:
```python
class JobPost(models.Model):
title = models.CharField(max_length=100, blank=False)
description = models.TextField(blank=False)
author = models.CharField(max_length=20, blank=False)
time = models.DateTimeField(auto_now_add=True, blank=False)
```
`settings.py`:
```py
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
# third party
# own
'JobPost',
]
```
`admin.py`:
```python
from .models import JobPost
admin.site.register(JobPost)
```
`python manage.py makemigrations`
`python manage.py migrate`