This project is a virtual bookshelf for Udacity students. Students are able to add their books to the bookshelf, give them a rating, update the rating and search through their book lists. As a part of the Fullstack Nanodegree, it serves as a practice module for lessons from Course 2: API Development and Documentation. By completing this project, students learn and apply their skills structuring and implementing well formatted API endpoints that leverage knowledge of HTTP and API development best practices.
All backend code follows PEP8 style guidelines.
Developers using this project should already have Python3, pip and node installed on their local machines.
From the backend folder run pip install requirements.txt. All required packages are included in the requirements file.
To run the application run the following commands:
export FLASK_APP=flaskr
export FLASK_ENV=development
export APP_CONFIG_FILE=<absolute_path_of_your_local_dir>/config/development.py
flask run
These commands put the application in development and directs our application to use the __init__.py file in our flaskr folder. Working in development mode shows an interactive debugger in the console and restarts the server whenever changes are made. If running locally on Windows, look for the commands in the Flask documentation.
The application is run on http://127.0.0.1:5000/ by default and is a proxy in the frontend configuration.
From the frontend folder, run the following commands to start the client:
npm install // only once to install dependencies
npm start
By default, the frontend will run on localhost:3000.
In order to run tests navigate to the backend folder and run the following commands:
dropdb bookshelf_test
createdb bookshelf_test
cd backend
pytest
The first time you run the tests, omit the dropdb command.
All tests are kept in that file and should be maintained as updates are made to app functionality.
- Base URL: At present this app can only be run locally and is not hosted as a base URL. The backend app is hosted at the default,
http://127.0.0.1:5000/, which is set as a proxy in the frontend configuration. - Authentication: This version of the application does not require authentication or API keys.
Errors are returned as JSON objects in the following format:
{
"success": False,
"error": 400,
"message": "Bad request"
}
API will return three error types:
- 400: Bad Request
- 404: Resource Not Found
- 422: Not Processable
- General
- Returns success value, list of book objects, and total number of books
- Results are paginated to groups of 8 - include a page parameter in request to choose (starting from 1)
- Sample
curl http://127.0.0.1:5000/books
{
"books": [
{
"author": "Stephen King",
"id": 1,
"rating": 5,
"title": "The Outsider: A Novel"
},
{
"author": "Lisa Halliday",
"id": 2,
"rating": 5,
"title": "Asymmetry: A Novel"
},
{
"author": "Kristin Hannah",
"id": 3,
"rating": 5,
"title": "The Great Alone"
},
{
"author": "Tara Westover",
"id": 4,
"rating": 5,
"title": "Educated: A Memoir"
},
{
"author": "Leila Slimani",
"id": 6,
"rating": 5,
"title": "Lullaby"
},
{
"author": "Amitava Kumar",
"id": 7,
"rating": 3,
"title": "Immigrant, Montana"
},
{
"author": "Madeline Miller",
"id": 8,
"rating": 5,
"title": "CIRCE"
},
{
"author": "Gina Apostol",
"id": 9,
"rating": 5,
"title": "Insurrecto: A Novel"
}
],
"success": true,
"total_books": 15
}
N/A
Me
The awesome team at Udacity and all of the students, soon to be full stack extraordinaires!