This week, you are building a Django application to collect an index of free programming books online. You'll work on this application for the entire week. The end goal is an application that allows users to see a list of all the books, register and log in, and favorite books.
- Your application should be styled. It should be usable and aesthetically neutral, at a minimum. There is a sample mockup of the index page in mockup/index.html. You do not have to follow this mockup -- it's just a place to start if you don't have your own ideas.
- When you are not sure about whether a feature is needed, use your knowledge of similar sites and your good sense.
- A starterproject and app are provided, along with a custom user model and the accompanying migration.
Your first goal should be creating a Book model and showing an index of all books. Some details:
- Books have, at a minimum, a title, author, description, URL, and date added to the database (
created_at). - Book URLs (the URL field in the database) should be unique.
- Admins can add, edit, and delete books.
- You should have initial data for books (a CSV is provided, but you can edit it to fit your data).
- Books should be displayed in order with the most recently added at the top.
To load some initial books into your database, you can create a data migration. Read the data from the CSV file and use your model to save data to the database. (Another good resource on data migrations.)
You can also create books using the Django admin.
- Add an optional image url for books.
- Allow users to change the sorting order of books, ordering by title or by reverse order of being added.
Your next goal is adding registration and login to your application. Change the flow of your application so that users have to log in to see their books.
Your next goal should be adding categories for books. Each book should be associated with a category.
- Categories have a title and a slug.
- Each category should have a URL that shows books just for that category.
- Allow books to be in multiple categories.
Once you have registration and login, users should be able to choose books as their favorites. Every user should be able to go to a URL, /favorites/, to see their favorite books. The books should be in order with the most recently favorited ones on top. The user can "un-favorite" a currently favorited book.
- Show the number of times a book has been favorited on its entry.
Users should be able to comment on books. Each book will need to have its own unique URL where you can see comments on the book. Comments should be in order from the oldest to the newest. On book listing pages (the main page and the category pages), the number of comments should be listed with the book.
- Make user names on comments links to a user profile page. This page should show all the comments the user has made on all books.
Users should be able to suggest new books for Freeshelf. You can do this with a separate model or by using the Book model with a new boolean indicating whether the suggestion has been accepted or not. Either way, a new page, /suggestions/, should be available to admins, showing them all the current suggestions and allowing them to accept or decline the suggestion.
This project was generated from the Momentum Django project template. This template sets up some minimal changes:
- django-extensions and django-debug-toolbar are both installed and set up.
- django-environ is set up and the
DEBUG,SECRET_KEY, andDATABASESsettings are set by this package. - There is a custom user model defined in
books.models.User. - There is a
templates/and astatic/directory at the top level, both of which are set up to be used. - A
.gitignorefile is provided. - Pipenv is used to manage dependencies.
> pipenv install
> cp django_freeshelf/.env.sample django_freeshelf/.env
> pipenv shell
> ./manage.py migrate
> ./manage.py createsuperuser # follow prompts to create a superuser
> ./manage.py runserver