I am doing CS50W course, Web Development with Python and JS. The Capstone project requires a README.md file. Requirements defined here: CS50W Capstone Requirements
I have changed and submitted my README.md file 3 times, still the same response, then changed my project all together and submitted to see if anything changes, but no. This is the response that I am getting. I really worked hard for my readme.md file and it has 196 lines, but I'm still not sure what they want or what the problem is. At this point, it's pretty depressing. I honestly don't know what to do anymore. I am attaching my file here, if anyone could point out the problem or what I need to add, it would be really helpful.
The grader's comment was:
The grader's comment was:
`Individual feedback
README.md does not contain all of the required information. https://cs50.harvard.edu/web/2020/projects/final/capstone/#requirements. Please read the red box on the page and ALL of the bullet points under it. Your README does not comply with at least one of those requirements.
A well-written README will consist of several paragraphs, and per the requirements outlined in the specification will *minimally* contain (a) a sufficiently thorough justification for why this project satisfies the distinctiveness and complexity requirements and (b) a full write-up of all of the files to which you've contributed code and what is contained in those files.
The README is a crucial part of your project; be sure you are affording it the time and effort it deserves.`
Thanks in advance!
# Final-Project
Web Programming with Python and JavaScript
# Introduction
This website is a Guitar Chords Website platform powered by Django. In this websie, users can search for songs arbitrarily or browse the latest songs in the home page.
For editors and artists, they can upload songs in a format of HTML.
This is the final project for CS50's Web Programming with Python and JavaScript.
#### Features
1. Search Song.
2. Get the full lyrics including chords of the song by clicking the song.
3. Like and unlike songs.
4. User's Profile.
5. Login and Register.
6. Author Songs Page to view all songs by that author.
7. Favourite Songs Page to view all the songs you have liked.
#### Files & Directories
- `Main Directory`
- `guitar_website` - Contains settings and main url file.
- `urls.py` - Contains all url paths for songs' views, home, admin site and all url paths for authentication, like login, sign up as well as logout.
- `screenshot` - Contains all the screenshots of all pages of the website
- `songs` - Main application directory
- `static` - Holds all static files.
-`songs`
-`images` - Holds all static images and icons
-`guitar.png` - favicon image.
-`main.css` - Contains styles for all pages.
- `templates` - Holds all html files.
- `forms.py` - Contains two form classes `UserRegisterForm` and `ProfileForm` which has all the fields of the forms.
- `models.py` - Contains two classes `Songs` and `Profile` which has all information about the songs and user.
- `views.py` - Contains all view functions for `home` to render the home page, `SongListView` to render all the songs with pagination by using Django's `Class-based Views` such as `SongDetailView` to open a detailed render with all the chords of the song, `AuthorSongListView` to render all the songs by that author with pagination, `login` to render the login page, `register` to render the register page, `add_to_fav_songs` to add the song in favourite songs list, `Fav_songs` to render all the users' favourite songs, `Profile` to render users' profile, as well as `about`.
- `requirements.txt` - Project dependencies.
# Project Structure
## Home Page
In the home page, you can search text in any part of songs by inputting any words in the search box, and click "Search" button.
Besides, if you just want the chords to something new, just click "Songs" Button and you will get some songs randomly. Additionally, you don't need to log in for those actions.
## Result Page
In the result page, you can get songs with title and its author. If you aren't satisfied with those results, you can continue to search in the top search bar.
If are are interested in some songs from the search result, you can click the title of the card, and you will be redirected to the full song detail page.
## Song Detail Page
In the song detail page, the detail of one song will be displayed, such as the title, author, and the most important part, the full lyrics and the chords.
Besides, if you are not logged in, it will also display a login prompt to the far right.
## Author Songs Page
If a user likes songs of a specific author, the user can click the author's name to go to the `Author Songs Page` to view all the songs of that author.
## Login Page
Before you can like songs, you need to login to allow the platform to remember you. Just input the username and password in the form below.
Don't have an account? No worries, as there is a link to the register page in the `signup` button below the form where new users can get registered as well.
## Register Page
New users can get registered by filling out the `UserRegisterForm` and then they will be redirected back to the login page when they can then login to start liking songs.
Users can now view their `profile`.
## Like Songs
After logging in, users can now like songs so that they don't have to search that song every time.
A song can be liked by clicking the red `heart` icon on the top right of the song card.
## Favorite Songs Page
After liking songs the user can then go to `Favorite Songs` Page to view their favorite songs which is much quicker and easier than scrolling through all the songs or searching the song.
## Pagination in Home Page and Liked Songs Page
I have included pagination in home page,liked songs and author songs page by using Django's `Class-based Views`.
## Profile Page
The `Profile` Page allows users to see their liked songs.
## About Page
The `About` Page contains information about the website like when was it created and some other stuff.
# Back End
## Super User
Super user is a feature provided by Django. The super user can manipulate all data in the Backend Management Dashboard.
Super user can also view all the details of all users.
## Songs
Admin is the person who can upload songs and has the authority and ability to add/change/delete/view songs in the backend dashboard.
## Song_view
Song_view is one of the most important entities of the platform. Song_view has fields like title, lyrics, author, favorited_by, track_image.
And then, the song will be saved and become visitable.
## Distinctiveness and Complexity
This project is distinct from all previous projects so far. Why?
- More models with complex relation between them.
- Uses ajax functionality, fetch data without reloading the page.
- Send password reset code using email.
- Completely Mobile responsive.
## How to run the application
* Install project dependencies by running `pip install -r requirements.txt`
* Make and apply migrations by running `python manage.py makemigrations` and `python manage.py migrate`.
# Finally
Thanks to all the people for making [CS50's Web Programming with Python and JavaScript](https://www.edx.org/course/cs50s-web-programming-with-python-and-javascript) for us. Especially, thanks to [Brain Yu](https://www.edx.org/bio/brian-yu)'s excellent lecture and his "great question", which motivated me to finish the course.
Abrar Shahriar,
August 22, 2022
## Distinctiveness and Complexityis not considered "it's own header" as per the spec (and in bold no less!) because it is## H2and not# H1. I wish you luck!#onDistinctiveness and Complexity, or the section isn't sufficient to show how it is distinct from previous projects.