neighbor-fave

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #machine-learning #deep-learning #docker #macos #windows #awesome #kubernetes #security #ios #openai #open-source

(★ 14)

fs capstone project

neighbor-fave Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<br />
<div align="center">
  <a href="//https://github.com/cs-team-02/neighbor-fave">
    <img src="public/apple-icon-180.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">Neighbor-Fave</h3>

<p align="center">
    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.
    <br />
    <a href="https://github.com/cs-team-02/neighbor-fave"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="#live-demo">View Demo</a>
    ·
    <a href="https://github.com/cs-team-02/neighbor-fave/issues">Report Bug</a>
    ·
    <a href="https://github.com/cs-team-02/neighbor-fave/issues">Request Feature</a>
  </p>
</div>

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
        <li><a href="#wireframe">Wireframe</a></li>
        <li><a href="#live-demo">Live Demo</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>

## About The Project
<div align="center">
  <img src="public/signing-screen.png" alt="Logo" width="330" height="600">
</div>

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.

### Built With

* [React.js](https://reactjs.org/)
* [Leaflet.js](https://leafletjs.com/)
* [Redux.js](https://reduxjs.org)
* [PWA](https://web.dev/learn/pwa/)
* [Express.js](https://expressjs.com/)
* [Node.js](https://nodejs.org/en/)
* [PostgreSQL](https://www.postgresql.org/)
* [Sequelize](https://sequelize.org/v5/)
* [Socket.IO](https://socket.io/)
* [Heroku](https://www.heroku.com/)

### Wireframe
Here are our design concepts.
<br />
[Wireframe](https://miro.com/app/board/uXjVOEbpKsw=/?share_link_id=481586375100)

### Live Demo
For ease of use we have included a demo account log in option on the sign in screen.
<br />
![demo-gif][demogif]
<br />
please click the `Demo Login` button to access the demo account.
<br />
Access the deployed App here:
[Live Demo](https://neighborfave.onrender.com)

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

### Installation

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

## Usage
[![Demo Video][thumbnail]](https://www.youtube.com/watch?v=X4i_PReaSVI&ab_channel=ChiKonstantin)
<p align="right">(<a href="#top">back to top</a>)</p>

## 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](https://github.com/cs-team-02/neighbor-fave/issues) for a full list of proposed features (and known issues).

## 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

## License

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

## Contact

* [Tedi](https://github.com/Tedicode)
* [Kwame](https://github.com/kjgumbs)
* [Konstantin](https://github.com/ChiKonstantin)
* [Adam](https://github.com/adam-marey)

Project Link: [https://github.com/cs-team-02/neighbor-fave](https://github.com/cs-team-02/neighbor-fave)

[contributors-shield]: https://img.shields.io/github/contributors/cs-team-02/neighbor-fave.svg?style=for-the-badge
[contributors-url]: https://github.com/cs-team-02/neighbor-fave/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/cs-team-02/neighbor-fave.svg?style=for-the-badge
[forks-url]: https://github.com/cs-team-02/neighbor-fave/network/members
[stars-shield]: https://img.shields.io/github/stars/cs-team-02/neighbor-fave.svg?style=for-the-badge
[stars-url]: https://github.com/cs-team-02/neighbor-fave/stargazers
[issues-shield]: https://img.shields.io/github/issues/cs-team-02/neighbor-fave.svg?style=for-the-badge
[issues-url]: https://github.com/cs-team-02/neighbor-fave/issues
[license-shield]: https://img.shields.io/github/license/cs-team-02/neighbor-fave.svg?style=for-the-badge
[license-url]: https://github.com/cs-team-02/neighbor-fave/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/linkedin_username
[thumbnail]: public/cover.png
[demogif]: public/giphy.gif

neighbor-fave

neighbor-fave Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

neighbor-fave

neighbor-fave Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README