amaniezz / encyclopedia-django-app

Wikipedia-like online encyclopedia.

Encyclopedia-Django-app

A Wikipedia-like online encyclopedia.

https://encyclopediaapp.herokuapp.com/

 This django app is a simple online encyclopedia, where each encyclopedia entry is represented by Markdown file, 
 so that our entries more human-friendly to write and edit, 
 then it is convert into HTML before displaying it to the user.

Functionalities

• 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 get 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: 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 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 Py, then Python should appear in the search results. Clicking on any of the entry names on the search results page should take 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, and 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 be 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 should be 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 be 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 take 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, using markdownfiy library.