betterReads is a social media platform that allows users to connect with other readers alike, search its database of books, browse recommendations, and manage their own library.

To get the server running locally:

• Clone this repo
• npm install to install all required dependencies
• npm run server to start the local server
• npm start only for production
• npm run test to start server using testing environment

• seed data is in database/seeds/ (seeds have been removed)

1. knex migrate:up --env=testing
2. knex migrate:up --env=testing
3. knex migrate:up --env=testing
4. knex seed:run --env=testing --specific=001-users.js
5. knex seed:run --env=testing --specific=001-books.js
6. knex migrate:up --env=testing
7. knex seed:run --env=testing --specific=002-user-books.js
8. knex migrate:up --env=testing
9. knex seed:run --env=testing --specific=002-user-shelves.js
10. knex migrate:up --env=testing
11. knex seed:run --env=testing --specific=003-user-books-on-a-shelf.js

• Simple routing
• Event driven features
• Uses Javascript, an omnipresent language in web development
• Large Community Support

🚫This is a placeholder, replace the endpoints, access control, and description to match your project

{ 
  fullName: STRING, 
  emailAddress: STRING, 
  password: STRING 
}

{
  emailAddress: STRING,
  password: STRING
}

{
	genre: STRING;
}

{
  googleId: STRING,
  title: STRING,
  authors: STRING,
  publisher: STRING,
  publishedDate: STRING,
  description: STRING,
  isbn10: STRING,
  isbn13: STRING,
  pageCount: INTEGER,
  categories: STRING,
  thumbnail: STRING,
  smallThumbnail: STRING,
  language: STRING,
  webReaderLink: STRING,
  textSnippet: STRING,
  isEbook: BOOLEAN,
  averageRating: DECIMAL
}

-- PUT /api/:userId/library

{
  bookId: FOREIGN KEY from books,
  readingStatus: INTEGER,
  favorite: BOOLEAN,
  dateStarted: STRING, (YYYY-MM-DD)
  dateEnded: STRING, (YYYY-MM-DD)
  userRating: DECIMAL
}

-- DELETE /api/:userId/library

{
  bookId: FOREIGN KEY from books
}

-- POST /api/:userId/library

{
  book: OBJECT,
  readingStatus: INTEGER,
  favorite: BOOLEAN
}

-- POST /api/shelves/user/:userId

{
  shelfName: STRING,
  isPrivate: BOOLEAN
}

-- GET /api/shelves/:shelfId

{
  bookId: FOREIGN KEY from books
}

-- PUT /api/shelves/:shelfId

{
  shelfName: STRING,
  isPrivate: BOOLEAN
}

-- DELETE /api/booksonshelf/shelves/:shelfId

{
  bookId: FOREIGN KEY from books
}

-- POST /api/booksonshelf/shelves/:shelfId

{
  book: OBJECT,
  readingStatus: INTEGER,
  favorite: BOOLEAN
}

-- PUT /api/booksonshelf/shelves/:shelfId

{
  bookId: FOREIGN KEY from books,
  newShelfId: ShelfID from updated shelf
}

-- GET /api/booksonshelf/shelves/:shelfId

{
  bookId: FOREIGN KEY from books
}

{
  id: UUID
  emailAddress: STRING
  password: STRING
}

{
  id: UUID
  genre: STRING
}

{
  id: UUID
  genreName: STRING
  userId: UUID foreign key in USER table
}

{
  id: UUID
  googleId: STRING
  title: STRING
  authors: STRING
  publisher: STRING
  publishDate: STRING
  description: STRING
  isbn10: STRING
  isbn13: STRING
  pageCount: INTEGER
  categories: STRING
  Thumbnail: STRING
  smallThumbnail: STRING
  language: STRING
  webRenderLink: STRING
  textSnipped: STRING
  isEbook: BOOLEAN
  averageRating: DECIMAL
}

{
  id: UUID
  bookId: UUID foreign key in GOOGLEBOOKS table
  userId: UUID foreign key in USERS table
  readingStatus: INTEGER (NULLABLE)
  dateStarted: DATETIME (NULLABLE)
  dateEnded: DATETIME (NULLABLE)
  dateAdded: DATETIME (AUTOMATICALLY GENERATED)
  favorite: BOOLEAN (NULLABLE)
}

{
  id: UUID
  userId: UUID foreign key in USERS table
  shelfName: STRING
  isPrivate: BOOLEAN (NULLABLE)
}

{
  id: UUID
  bookId: UUID foreign key in BOOKS table
  shelfId: UUID foreign key in USERSHELVES table
}

add(user object) -> Returns the created user

findBy(filter) -> Return all users matching filter

count() -> Return total number of users

findBy(filter) -> returns an array of books associated to filter

getAll() -> Returns all books

add(book object) -> Returns a single book

findById(id) -> Returns a single book

findBy(filter) -> Returns an array book from user's library

add(book) -> Returns a single book

findById(bookId) -> Finds book by bookId

findFavorites(userId) -> Returns array of favorite books

isBookInUserBooks(userId, googleId) -> Checks if book is already in user's library

findByUserId(userId) -> Return all books in user's library

findDetailByUserId(userId, bookId) -> Return a single book with full details

find(userId, bookId) -> Return a single book with no details

update(userId, bookId, update) -> Return a single book with full details

remove(userId, bookId) -> Returns nothing

findBy(filter) -> Returns an array of bookshelves

findByUser(id) -> Returns an array of bookshelves

returnShelfId(userId) -> Returns an array of shelf ids

add(shelf) -> Returns a single bookshelf

update(updatedShelf, shelfId) -> Returns a single bookshelf

remove(shelfId) -> Returns nothing

findBook(shelfId, bookId) -> Returns books on shelf

findAllBooks(shelfId) -> Return all books on shelf

returnEveryShelfFrom(userId) -> Returns all books from user's shelves

findBooksIn(shelfId) -> Returns books on shelf

findById(id) -> Returns shelf with book

addBooks(book) -> Returns book

remove(bookId, shelfId) -> Returns nothing

removeAll(bookId, userId) -> Returns removed shelf id

booksFor(userId) -> Returns all books for user

shelvesFor(userId) -> Returns all shelves for user

find(userId) -> Returns number of books on a shelf

findBooksIn(shelfId) -> Returns all books on shelf

findBy(userId) -> Returns everything about user

In order for the app to function correctly, the user must set up their own environment variables.

create a .env file that includes the following:

* DB_ENV - set to "development" until ready for "production"
* HOST - set to host (i.e., localhost)
* DB_USER - set to username on your postgres server
* PASSWORD - set to password for user on your postgres server
* DB - set to database name for your postgres server
* TEST_DB - set to test database name for your postgres testing server

* SESSION_NAME - ...
* SESSION_SECRET - ...
* GOOGLE_CLIENT_ID - this is generated in your google account
* GOOGLE_CLIENT_SECRET - this is generated in your google account
* FACEBOOK_CLIENT_ID - this is generated in your facebook account
* FACEBOOK_CLIENT_SECRET - this is generated in your facebook account

* BASE_URL - set in "production" for elastic beanstock
* FAIL_URL - set in "production" for elastic beanstock
* SUCCESS_URL - set in "production" for elastic beanstock
* GOOGLE_CALLBACK - set in "production" for elastic beanstock
* FACEBOOK_CALLBACK - set in "production" for elastic beanstock

* NODE_ENV - set to "development" until ready for "production"
* RDS_HOSTNAME - set in "production"
* DATA_SCIENCE - set in "production"
* DATE_SCIENCE_TOTAL - set in "production"

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

These contribution guidelines have been adapted from this good-Contributing.md-template.

See 📱💻🖱Frontend Documentation for details on the frontend of our project. See 🔬⚗️🧪Data Science Documentation for details on the data science of our project.