mamume / wiki-web50

Wiki - CS50's Web Programming with Python and JavaScript Project 1

Wiki

A Wikipedia-like online encyclopedia.

Description

In Wikipedia web application, you can create, edit or delete a wiki page. Made using Django Framework. Topics are formatted using Markdown markup language.

Installation

pip install -r requirement.txt

Database Processing

python mange.py makemigrations
python manage.py migrate

Run Project

python manage.py runserver

Specification

• Entry Page: Visiting /wiki/TITLE, where TITLE is the title of an encyclopedia entry, will render 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 will be presented with an error page indicating that their requested page was not found.
  • If the entry does exist, the user will be presented with a page that displays the content of the entry. The title of the page includes the name of the entry.
• Index Page: In index.html, user can click on any entry name to be taken directly to that entry page.
• Search: User can 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 will be redirected to that entry’s page.
  • If the query does not match the name of an encyclopedia entry, the user will instead be 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 should appear in the search results.
  • Clicking on any of the entry names on the search results page will take the user to that entry’s page.
• New Page: Clicking “Create New Page” in the sidebar will take 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, will be 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 will be presented with an error message.
  • Otherwise, the encyclopedia entry will be saved to disk, and the user will be taken to the new entry’s page.
• Random Page: Clicking “Random Page” in the sidebar will take user to a random encyclopedia entry.
• Markdown to HTML Conversion: On each entry’s page, any Markdown content in the entry file will be converted to HTML before being displayed to the user. python-markdown2 package is used to perform this conversion, installable via pip3 install markdown2.

For more details: Wiki - CS50's Web Programming with Python and JavaScript