Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.65 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.65 KB

Bird's Eye View

This is a text-based adventure game played entirely through the CLI. You play a day in the life of a city crow who's only wish to find a decent meal goes off the rails, and plunges them into the secret world of urban animals both seen and unseen.

Requirements

MongoDB, Node.js, and your favorite CLI

Installing

  1. Clone down the repository and change the directory.

    git clone https://github.com/team-lollipop/birds-eye-view.git

  2. Install the dependencies from package.json.

    npm i

  3. Type run command into the CLI to start the game!

    node cli

Built With

  • Inquirer - Package used to create a client side interface for the CLI
  • bcryptjs - Used for security
  • jsonwebtoken - Used to generate authentification tokens
  • Mocha - Used for development testing
  • Chai - Used for development testing
  • mongoose - Model validation

Authors

with inspiration from Space Explorers

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details