Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 3.03 KB

README.md

File metadata and controls

100 lines (76 loc) · 3.03 KB
Raw

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

  • 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

Home Page Author Page

Technologies

This project is built with:

Setup Instructions

Clone the repository:

$ 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.

$ export SECRET_KEY='your_secret_key'

and then change line 24 of settings.py to:

SECRET_KEY = os.environ['SECRET_KEY']

Another way of doing it is to put it in line 1 of keys.py, although this is not the best practice.

Then install the dependencies:

$ pip3 install -r requirements.txt

Once pip has finished downloading, you can run the server:

$ 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, please open an issue here before working on it.

Sources

This project is inspired by a Django tutorials playlist by Codemy.

forthebadge