jtwray / bookr

This project was bootstrapped with Create React App.

BOOKR

Bookr allows a user to explore and discover knowledge in the form of books. Available to registered users

• access to an encrypted dashboard
  • my_bookshelf
    • a place to store your purchased books
  • explore recommended books not in your store yet
  • search new books

tech stack

REACT | REDUX | NODE | EXPRESS | KNEX | POSTGRESQL | FAUNA | SERVERLESS | REACT-TESTING-LIBRARY | JEST | SUPERTEST

Getting Started

• clone down the REPO

• cd into the project root directory './bookr'

  • if you enter ls to the root directory directory you should see a package.json file at this level
  • seeing the package.json file would denote you are in the correct level

• install project dependencies

npm install

• spin up project on localhost

npm run start

contributing to the project

• create a feature branch related to the issue or addition you want to contribute to the project using git commands ie

git checkout -b navbar_loginbutton__uianimation

• make commits as you develop features
• create unit tests to increase feature integrity over the long term of the project
• make a Pull Request against the master branch
• watch for reviews from project core contributors
• collaborate to resolve any changes or adjustments necessary to have the feature merged in as a permanent contribution to the project