NeighborGood is a two-semester long senior project in SE195A/B at San José State University in Spring 2019. NeighborGood is a web application that focuses on providing convenient communication for users and improving relationships between people living in the same neighborhoods. Neighbourly relations have decreased in the United States since the 1950s which has resulted in a lack of communication between neighbors. Additionally, only 20% of Americans spend their time with the people living next door. As a team, we are aware of the social issue and decided to create a platform and provide an opportunity for our users to actively interact with each other online.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
need to install Node.js
1:clone NeighborGood 2:Navigate to client folder npm install 3:Navigate to server folder npm install
Folder structure options and naming conventions for software projects
.
├── server # Project root
│ ├── client # Front-end related directory
│ │ ├──public # Public Files
│ │ ├──src # Source Files of front-end
│ │ │ ├──actions # React-redux actions handlers
│ │ │ ├──app # React App root
│ │ │ ├──features # Components
│ │ ├──package.json # Packages dependency and scripts for front-end
│ ├── config # configurations
│ ├── middleWare # customize middlewares
│ ├── models # Database schemas
│ ├── routes # Rest APIs
│ ├── services # Third party services apis
│ ├── index.js # Main page
│ ├── package.json # Packages dependency and scripts for server
└── README.md
- MongoDB(https://www.mongodb.com/) - Database
- Express(https://www.express.com/) - Web application framework for Node.js
- React(https://www.reactjs.com/) - JavaScript Library for building Front-end UI
- Node.js(https://nodejs.org/en/) - JavaScript based back-end server building tool
- NPM(https://npmjs.com/) - JavaScript packages management tool
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Renjie Ye, shunyu, Yihua Li, Quang Tiep Du
This project is licensed under the MIT License - see the LICENSE.md file for details
As a team, we would like to take a moment to anyone who has helped and supported us throughout the project. First of all, we would like to express our gratitude to professor Fabio Di Troia who has agreed to be our advisor. He always gave us the necessary time we needed during the meetings. He supported our ideas and provided us with important and helpful feedback. Last but not least, we would like to thank our friends, classmates, and family members who provided us with support.