Dropbox Reads

Community for Dropboxers to learn, share knowledge, and grow by reading together

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prereqs
   • SSH
   • .env
   • Installation
3. Contributing
4. License
5. Contact

About The Project

• PRD
• Hackdash

Built With

• TypeScript
• React
• Redux

Getting Started

Prereqs

• npm

  npm install -g npm

• homebrew

  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

• yarn

  brew install yarn

SSH

1. Generate a new SSH key and save as id_ed25519_gh. Don't overwrite your Dropbox id_ed25519!
2. Update your ssh config

#### Place local modifications below this line ####

Host *github.*
IdentityFile ~/.ssh/id_ed25519_gh

#### Place local modifications above this line ####

.env

1. Use

REACT_APP_ENV=development
REACT_APP_API_URL=https://api.dropboxreads.com
REACT_APP_GOOGLE_CLIENT_ID=<ID>
REACT_APP_GOOGLE_CLIENT_SECRET=<SECRET>
REACT_APP_GOOGLE_BOOKS_API_KEY=<KEY>
PRIVATE_REFRESH_TOKEN=<TOKEN>

2. Request keys at #dropbox-reads

Installation

1. Clone the repo using SSH

   git@github.com:matt-ramotar/dropbox-reads.git

2. Install NPM packages

   yarn install

3. Run start script

   yarn start

Contributing

1. Follow Getting Started above
2. Create branch

   git checkout -b feature/<name>

3. Commit changes

   git commit -m Add feature

4. Push to branch

   git push origin feature/<name>

5. Open Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• #dropbox-reads
• mramotar@dropbox.com