algobook/algobook

📖 A curated book of Algorithms

algoBook

Objective: To Develop a community based platform where people can learn and share algorithms of any language and platform.

algoBook is focused to curated list of algorithms, solutions and their explanations on the basis of community feedback. It is an open platform for users to come and submit solutions to various algorithms in any language and of any platform.

Installation

Steps

Make sure you have the dependencies mentioned above installed before proceeding further.

• Step 0 - Clone the algoBook/algoBook repository (from the development branch) and cd into the directory.

git clone -b development https://github.com/algobook/algobook.git
cd algobook

• Step 1 - Install python requirements. You need to be present into the root directoryt of the project.

sudo -H pip install -r requirements.txt

• Step 2 - Algobook expect two enviroment variables for sending email. You can set them to dummy for testing.

 export DJANGO_EMAIL='dummy'
 export DJANGO_EMAIL_PASSWORD='dummy'

• Step 3 - Run Migration, create database

python manage.py migrate

• Step 4 - Install bower and frontend requirements. For this you need to be present in the root directory of the project. The root directory contains the file bower.json. When you write bower install, it finds bower.json and installs the libraries on the system.

npm install bower -g
bower install

if error

sudo npm install bower -g
sudo ln -s /usr/bin/nodejs /usr/bin/node
sudo bower install

for mac user:

sudo npm install bower -g
bower install

run app

python manage.py runserver

Mozilla Community Participation Guidelines

algobook's Issues

Add unittest support with nose2

Please look into library https://github.com/nose-devs/nose2

1. We need to implement unit testing in our Django application.
2. This is a parent issue. Child issue can be created if you creating specific part of unit testing

What should be covered in them:
We need to make sure we are getting correct views
Correct search results
correct error pages

Improve login button

Suggestions on login button at home page.

Remove right margin from author's name block

For example see here: http://algobook.net/algo/bubble-sort/?lang=

Show available tags of an algorithm in the search result blocks.

Please show tags (like python, cpp) of an algorithm in their result boxes. Try to pick the colors from the logo for the tags.

Apply 'Source Code Pro' font-family to the whole site

Now the whole site using standard Bootstrap font-family: Helvetica Neue",Helvetica,Arial,sans-serif. But check how good it would look if font-family: "Source Code Pro"; is applied to the body tag.

Link sitemap to home page

Create a footer section with just small text in the bottom of home page. This section will be used to add footer links.

And then add following links:
Sitemap - /sitemap.xml

Create Sitemap for Code Model

Currently, we have sitemap only for Algos. We need Sitemap for Code Model as well. Please look last commits to see how sitemap is implemented.

Convention to follow:

Priority: 1
Url: /code/int:id/<create_slug_from_title>
Updated: daily