-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,38 @@ | ||
# Bookboxd | ||
letterboxd but for books | ||
|
||
## Features | ||
|
||
- Search for books using the Google Books API | ||
- Create and manage personal book lists | ||
- Explore book lists created by other users | ||
- Like and comment on book lists | ||
- View detailed information about each book | ||
|
||
## Setup | ||
|
||
1. Clone the repository | ||
2. Install dependencies: `pip install -r requirements.txt` | ||
3. Set up your Google Books API key in `settings.py` | ||
4. Run migrations: `python manage.py migrate` | ||
5. Start the server: `python manage.py runserver` | ||
|
||
## Usage | ||
|
||
- Register/Login to create and manage your book lists | ||
- Use the search function to find books and add them to your lists | ||
- Explore other users' lists, like them, and leave comments | ||
- Click on any book to view its detailed information | ||
|
||
## Technologies Used | ||
|
||
- Django | ||
- Python | ||
- SQLite | ||
- HTML/CSS | ||
- JavaScript/jQuery | ||
- Google Books API | ||
|
||
## Contributing | ||
|
||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. |