https://github.com/codelixir/nought-pad
A blog website made using Django.
https://github.com/codelixir/nought-pad
bootstrap django hacktoberfest python
Last synced: about 11 hours ago
JSON representation
A blog website made using Django.
- Host: GitHub
- URL: https://github.com/codelixir/nought-pad
- Owner: codelixir
- License: mit
- Created: 2021-06-07T17:37:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-23T07:57:21.000Z (over 4 years ago)
- Last Synced: 2025-02-13T18:42:29.620Z (11 months ago)
- Topics: bootstrap, django, hacktoberfest, python
- Language: Python
- Homepage:
- Size: 544 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoughtPad
This is a basic blog website made using Django and Bootstrap. It is my first ever project in Django, hence the Nought(`[0]`) in NoughtPad.
## Table of Contents
- [Features](#features)
- [Screenshots](#screenshots)
- [Technologies](#technologies)
- [Setup Instructions](#setup-instructions)
- [Project Status](#project-status)
- [Contributions](#contributions)
- [Sources](#sources)
## Features
- Sign-in/Sign-up
- Adding, Editing, Deleting Notes
- Using RichText in Note body
- Uploading header images in Notes
- Liking anyone's Notes
- Author page
- Profile card with profile picture, bio and external links
- All Notes posted by the author
- Edit profile/user settings
## Screenshots
## Technologies
This project is built with:
* [Django 3.2.4](https://www.djangoproject.com/)
* [Bootstrap 4.4.1](https://getbootstrap.com/docs/4.4/getting-started/introduction/)
## Setup Instructions
Clone the repository:
```sh
$ git clone https://github.com/codelixir/nought-pad.git
$ cd nought-pad
```
Now if you wish, you can create ans activate a virtual environment (recommended).
You also need a Secret Key for Django. A good way to do it is storing `SECRET_KEY` as an environment variable.
```sh
$ export SECRET_KEY='your_secret_key'
```
and then change line 24 of [`settings.py`](noughtpad/settings.py) to:
```py
SECRET_KEY = os.environ['SECRET_KEY']
```
Another way of doing it is to put it in line 1 of [`keys.py`](noughtpad/keys.py), although this is not the best practice.
Then install the dependencies:
```sh
$ pip3 install -r requirements.txt
```
Once `pip` has finished downloading, you can run the server:
```sh
$ python3 manage.py runserver
```
and navigate to `http://127.0.0.1:8000/`
## Project Status
I will not be working on this project for now, but there are a number of improvements that can be made. For example:
- [ ] Making the navbar sticky
- [ ] Improving responsiveness
- [ ] Adding dark mode
- [ ] Making a separate profile page
- [ ] Option to upload in-text images in notes
- [ ] Adding comments to notes
- [ ] Adding categories to notes
## Contributions
Want to contribute? Awesome!
To fix a bug or add/enhance a feature (out of those listed above, or anything else you find interesting), follow these steps:
- Fork the repo
- Create a new branch (`git checkout -b improve-feature`)
- Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (`git commit -am 'Improve feature'`)
- Push to the branch (`git push origin improve-feature`)
- Create a Pull Request
If you want to add a feature not listed under [project status](#project-status), please open an issue [here](https://github.com/codelixir/nought-pad/issues/new) before working on it.
## Sources
This project is inspired by a Django tutorials playlist by [Codemy](https://codemy.com/).
---
[](https://forthebadge.com)