/dropbox-reads-api

Dropbox Reads API

Primary LanguageTypeScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License


Logo

Dropbox Reads API

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

View Models · Read Docs · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact

About The Project

Built With

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
NODE_ENV=development
PORT=5000
MONGODB_URI=<URI>
SECRET_OR_KEY=<SECRET OR KEY>
  1. Request keys at #dropbox-reads-api

Installation

  1. Clone the repo using SSH 
    git@github.com:matt-ramotar/dropbox-reads-api.git
  2. Install NPM packages 
    yarn install
  3. Run dev script 
    yarn run dev

Manual Testing

  1. Compass
  2. Postman

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