https://github.com/ahr9n/cs50w-wiki

A design of Wikipedia-like online encyclopedia. Project 1 for CS50’s Web Programming with Python and JavaScript.
https://github.com/ahr9n/cs50w-wiki

cs50w cs50web cs50web-project1 django encyclopedia wiki

Last synced: 17 days ago
JSON representation

A design of Wikipedia-like online encyclopedia. Project 1 for CS50’s Web Programming with Python and JavaScript.

• Host: GitHub
• URL: https://github.com/ahr9n/cs50w-wiki
• Owner: ahr9n
• Created: 2022-03-20T13:31:00.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-26T07:37:12.000Z (over 2 years ago)
• Last Synced: 2024-07-30T21:03:20.467Z (3 months ago)
• Topics: cs50w, cs50web, cs50web-project1, django, encyclopedia, wiki
• Language: Python
• Homepage:
• Size: 89.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


 



# Wiki

Project 1 for CS50’s Web Programming with Python and JavaScript.

## Overview

A design of Wikipedia-like online encyclopedia.

## Specifications

This project fulfills the following requirements:

* **Entry Page**: Visiting `/wiki/TITLE`, where `TITLE` is the title of an encyclopedia entry, renders a page that displays the contents of that encyclopedia entry.

  * The view gets the content of the encyclopedia entry by calling the appropriate `util` function.

  * If an entry is requested that does not exist, the user is presented with an error page indicating that their requested page was not found.

  * If the entry does exist, the user is presented with a page that displays the content of the entry. The title of the page includes the name of the entry.

* **Index Page**: Updates `index.html` such that, instead of merely listing the names of all pages in the encyclopedia, user can click on any entry name to be taken directly to that entry page.

* **Search**: Allowing the user to type a query into the search box in the sidebar to search for an encyclopedia entry.

  * If the query matches the name of an encyclopedia entry, the user is redirected to that entry’s page.

  * If the query does not match the name of an encyclopedia entry, the user instead is taken to a search results page that displays a list of all encyclopedia entries that have the query as a substring. For example, if the search query were `ytho`, then `Python` appears in the search results.

  * Clicking on any of the entry names on the search results page takes the user to that entry’s page.

* **New Page**: Clicking “Create New Page” in the sidebar takes the user to a page where they can create a new encyclopedia entry.

  * Users are able to enter a title for the page and, in a [`textarea`](https://www.w3schools.com/tags/tag_textarea.asp), are able to enter the Markdown content for the page.

  * Users are able to click a button to save their new page.

  * When the page is saved, if an encyclopedia entry already exists with the provided title, the user is presented with an error message.

  * Otherwise, the encyclopedia entry is saved to disk, and the user is taken to the new entry’s page.

* **Edit Page**: On each entry page, the user is able to click a link to be taken to a page where the user can edit that entry’s Markdown content in a `textarea`.

  * The `textarea` is pre-populated with the existing Markdown content of the page. (i.e., the existing content is the initial `value` of the `textarea`).

  * The user is able to click a button to save the changes made to the entry.

  * Once the entry is saved, the user is redirected back to that entry’s page.

* **Random Page**: Clicking “Random Page” in the sidebar takes user to a random encyclopedia entry.

* **Markdown to HTML Conversion**: On each entry’s page, any Markdown content in the entry file is converted to HTML before being displayed to the user. Referring to [`python-markdown2`](https://github.com/trentm/python-markdown2) package to perform this conversion, installable via `pip3 install markdown2`.

## Setup

Requires Python3 and the package installer for Python (pip) to run:

* Install requirements (Django4 and Markdown2): `pip install -r requirements.txt`

* After cloning the repository, refer to the project folder and run the app locally: `python3 manage.py runserver`

* Visit the site: `http://localhost:8000` and enjoy!

## Topics

Built with [`Python`](https://www.python.org/downloads/), [`Django`](https://www.djangoproject.com/), [`Markdown`](https://pypi.org/project/Markdown/) and HTML/CSS.

## Future Work

Some challenges I would make in my free-time:

* Try implementing the Markdown to HTML conversion without using any external libraries, supporting headings, boldface text, unordered lists, links, and paragraphs.

  * Notice that using regular expressions in Python maybe helpful.