/neighbor-fave

fs capstone project

Primary LanguageJavaScriptMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License


Logo

Neighbor-Fave

The vision for Neighbor-Fave is to facilitate the creation and strengthening of community bonds through small acts of kindness. The app also promotes sustainability through pooled resources.
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

Logo

NeighborFave links you with users who live nearby, creating a community that can rely on one another for neighborly things, like: borrowing a ladder or moving a couch.

Need help with something? Post an “ask” to let your community know! Want to help out? Browse a map to connect with users in need.

(back to top)

Built With

(back to top)

Wireframe

Here are our design concepts.
Wireframe

(back to top)

Live Demo

For ease of use we have included a demo account log in option on the sign in screen.
demo-gif
please click the Demo Login button to access the demo account.
Access the deployed App here: Live Demo

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

  1. Clone the repo
    git clone https://github.com/cs-team-02/neighbor-fave.git
  2. Install NPM packages
    npm install

(back to top)

Usage

Demo Video

(back to top)

Roadmap

  • Image capture and storage using s3 on AWS to host user photos.
  • Upgrades to chat:
    • persistent storage of messages
    • push notifications
  • Display user activity history
  • Utilizing Mobile device hardware for authentication

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Project Link: https://github.com/cs-team-02/neighbor-fave

(back to top)