Giter Club home page Giter Club logo

pearlwiki's Introduction

๐Ÿ“ NYC

pearlwiki's People

Contributors

bthuilot avatar dependabot[bot] avatar

Watchers

 avatar  avatar  avatar

pearlwiki's Issues

Add category home page customization

Add in the ability for users to customize the home page of a category

  • Should come with default page
  • Users should be able to edit the home page
  • Should support markdown styling

Add dark mode

Add a dark mode for users.

  • Users can set dark mode for their account (once users are added)
  • Dark mode can still be turned out if not logged in and lasts for the session

Add basic user features

Add in basic user features such as

  • Ability to create a new user
  • Ability to login in as an existing user
  • Ability to edit existing user
  • Ability to delete an existing user

Users should also:

  • Have valid email addresses (for the time being that just means [username]@[website].[tld])
  • Not have duplicate emails
  • Have hashed and secure passwords

Update README

Update readme to include

  • Info about PearlWiki
  • How to Install/Run
  • How to configure
  • Say 'feel free to contribute'

Write all tests

Test have been forgone for as now as the wiki keeps changing and to save time and have it hopefully finished by September.
This is just a card to remember to finish all tests before releasing version 1.0.0

Add home page customization

Add in the ability for the user to customize the homepage

  • Should be a default home page
  • Users should be able to edit homepage
  • Should support mark down styling

Add search functionality

Add the search bar functionality

  • User can select a category and search a term and it will order by best fit
  • Only display ~20 results
  • User can also search in all categories

Extra functionality:

  • Search also searches text on page
  • User can increase search limit

Deleting Category must delete Posts in Category

When a Category is deleted, all posts in the category should be deleted as well.
Add in functionality to delete all posts as well
Be sure to prompt the user that deleting the category will also delete posts, and be sure to confirm before sending the request

Styling Fixes

This issue is a collection of styling issues found on the site that need to be fixed:

  • Post and category edit and delete buttons spacing
  • Search Bar category select
  • Consistent color and fix spacing on the sidebar

Completed

Documentation

The wiki currently contains little documentation

  • Create documentation using RDoc

Add Sidebar to wiki

  • Add a sidebar to the wiki that has a drop-down for each category
  • In category dropdown, it will list all posts in that category

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.