nazehs / bookshelf

Bookshelf

Local Development

The instructions below are meant for the local setup only.

Pre-requisites

• Developers using this project should already have Python3, pip and node installed on their local machines.

• Start your virtual environment

From the backend folder run

# Mac users
python3 -m venv venv
source venv/bin/activate
# Windows users
> py -3 -m venv venv
> venv\Scripts\activate

• Install dependencies
  

From the backend folder run

# All required packages are included in the requirements file. 
pip3 install -r requirements.txt
# In addition, you will need to UNINSTALL the following:
pip3 uninstall flask-socketio -y

Step 0: Start/Stop the PostgreSQL server

Mac users can follow the commands below:

which postgres
postgres --version
# Start/stop
pg_ctl -D /usr/local/var/postgres start
pg_ctl -D /usr/local/var/postgres stop 

Windows users can follow the commands below:

• Find the database directory, it should be something like that: C:\Program Files\PostgreSQL\13.2\data

• Then, in the command line, execute the folllowing command:

# Start the server
pg_ctl -D "C:\Program Files\PostgreSQL\13.2\data" start
# Stop the server
pg_ctl -D "C:\Program Files\PostgreSQL\13.2\data" stop

If it shows that the port already occupied error, run:

sudo su - 
ps -ef | grep postmaster | awk '{print $2}'
kill <PID> 

Step 1 - Create and Populate the database

1. Verify the database username
   

Verify that the database user in the /backend/books.psql, /backend/models.py, and /backend/test_flaskr.py files must be either the student or postgres (default username). FYI, the classroom workspace uses the student/student user credentials, whereas, the local implementation can use the dafault postgres user without a password as well. (See the /backend/setup.sql for more details!)

2. Create the database and a user
   

In your terminal, navigate to the /backend/* directory, and run the following:

cd /backend
# Connect to the PostgreSQL
psql postgres
#View all databases
\l
# Create the database, create a user - `student`, grant all privileges to the student
\i setup.sql
# Exit the PostgreSQL prompt
\q

3. Create tables
   

Once your database is created, you can create tables (bookshelf) and apply contraints

# Mac users
psql -f books.psql -U student -d bookshelf
# Linux users
su - postgres bash -c "psql bookshelf < /path/to/backend/books.psql"

You can even drop the database and repopulate it, if needed, using the commands above.

Step 2: Start the backend server

Navigate to the /backend/flaskr/__init__.py file, and finish all the @TODO thereby building out the necessary routes and logic to get the backend of your app up and running.

start your (backend) Flask server by running the command below from the /backend/ directory.

export FLASK_APP=flaskr
export FLASK_ENV=development
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 will run on http://127.0.0.1:5000/ by default and is set as a proxy in the frontend configuration. Also, the current version of the application does not require authentication or API keys.

Step 3: Start the frontend

(You can start the frontend even before the backend is up!) 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. Close the terminal if you wish to stop the frontend server.

---

Additional information

Running Tests

If any exercise needs testing, navigate to the /backend folder and run the following commands:

psql postgres
dropdb bookshelf_test
createdb bookshelf_test
\q
psql bookshelf_test < books.psql
python test_flaskr.py

Documentation

Error Handling

all the errors are return as JSON objects with the following structure:

{
    "success":False,
    "message": "message",
    "error": 400
    }

Error Status codes:

• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 404: Not Found
• 405: Method Not Allowed
• 409: Conflict
• 500: Internal Server Error
• 503: Service Unavailable
• 429: Too Many Requests
• 502: Bad Gateway
• 422: Unprocessable Entity

Endpoints

GET /books

• Returns a list of all books
• result is paginated (10 books per page)
• has a page query parameter to specify the page number

sample request:

GET /books?page=1

sample response:

{
    "success": True,
    "books": [
      {
        "id": 1,
        "title": "The Great Gatsby",
        "author": "F. Scott Fitzgerald",
        "rating": 5,
    },
    {
        "id": 2,
        "title": "The Great Gatsby",
        "author": "F. Scott Fitzgerald",
        "rating": 5,
    }
   
    ]
}
``

### GET /books/<int:book_id>

- Returns a single book

sample request:

```json
GET /books/1

POST /books

• Creates a new book
• Requires the title and author query parameters
• Returns the newly created book
• Returns a 400 error if the title or author query parameters are not provided
• accepts a search query parameter to search for books by title

search sample request:

POST /books

{
    "search": "The Great Gatsby",
}
sample response:
```json
{
    "success": True,
    "total_books": 1,
    "books": [
      {
        "id": 1,
        "title": "The Great Gatsby",
        "author": "F. Scott Fitzgerald",
        "rating": 5,
    },
    {
        "id": 2,
        "title": "The Great Gatsby",
        "author": "F. Scott Fitzgerald",
        "rating": 5,
    }
   
    ]
}

create sample request:

POST /books
{
    "title": "The Great Gatsby",
    "author": "F. Scott Fitzgerald",
    "rating": 5
}
### PUT /books/<int:book_id>
- Updates a book
- Accepts the `title` and `author` and `rating` 
- Returns the updated book
sample request:
```json
PUT /books/1
{
    "title": "The Great Gatsby",
    "author": "F. Scott Fitzgerald",
    "rating": 5
}

DELETE /books/int:book_id

• Deletes a book
• Returns a 204 status code if successful sample request:

DELETE /books/1

Deployment N/A

Author

Nazeh Abel

Acknoledgements N/A

References / Further Reading N/A