🤝 Welcome to Neighbr!

A Community-Building Application For All Your Needs

---

🧭 Navigation

• Features
• Installation
• Usage and Examples
• Running Tests
• Environment
• Optimizations
• Technologies & Tools
• Skills
• Contributors
• Links
• Screenshots
• Special Acknowledgements

📋 Features

• Signup & Login
• Navigation
• User Profiles
• Requester Dashboard
• Runner Dashboard
• Requester Status Window
• Runner Status Window

💾 Installation

1. Clone the repository:
   git clone https://github.com/rpp31-boc-lachesis/neighbr.git
2. Install dependencies:
   npm install

⚗️ Usage & Examples

1. Signup/Login
2. Request or run an errand
3. Track your progress
4. Thank your neighbor
5. View your profile or others

🧪 Running Tests

Our test suite is set up with Jest, React Testing Library, and Mock Service Worker.
To run the test suite in development, simply run:

  npm test

or, when deploying via your CI/CD pipeline:

  npm test:ci

⛰️ Environment

Copy .env.example to .env and fill in your information.

NODE_ENV="PRODUCTION or DEVELOPMENT"
PORT="EXPRESS-PORT"

PRODUCTION_URL="productionURL"

DB_URI="mongo://your.mongo.uri"
DB_NAME="mongoDatabaseName"
DB_USER="mongoUsername"
DB_PASSWORD="mongoUserPassword"

MONGO_INITDB_ROOT_USERNAME="rootUsernameForMongoDBDocker"
MONGO_INITDB_ROOT_PASSWORD"rootPasswordForMongoDBDocker"

MAPBOX_API_KEY="YourAPIKey"

jwtSecret="your JWT auth secret"

⚙️ Optimizations

1. Bundling of React code and all media assets with Webpack
2. Use of compression middleware for faster payload transfers
3. Performance-tuned database queries
4. Use of Passport JS for secure authentication and reduction of malicious behavior
5. Containerization for ease of deployment and scaling
6. Use of React Router for faster page loads and seamless user experience
7. Continuous integration and continuous deployment for faster development and shipment
8. NGINX placed as proxy server for security enhancement and future load-balancing & caching

💻 Technologies & Tools

🛠 Skills

• RESTful API architecture
• Modular controllers
• Object relational database management
• Secure authentication and sign-up
• Request and run location tracking
• Responsive web design / mobile friendly
• Dynamic and conditional rendering
• Map navigation
• High test coverage
• Containerization
• Continuous integration and continuous deployment

🤖 Contributors

• Git Hub
  • 
• Jake Caughern - Architecture Owner
  • 
• Cameron Colaco - Software Engineer
  • 
• Josh Fuqua - Product Manager
  • 
• Michael Lapid - UI Owner
  • 
• Yitong Liu - Software Engineer
  • 
• Maxine Majnaric - Software Engineer
  • 
• Mary Miyamoto - Software Engineer
  • 

🔗 Links

• 👇 Visit our homepage!
  

  • Neighbr

📷 Screenshots

• Signup & Login

  Checkout how it works here 👉 Demo

• Navigation

  Checkout how it works here 👉 Demo

• Requester Dashboard

• Runner Dashboard

  

• Requester Status Window

• Runner Status Window

• User Profiles

🔊 Special Acknowledgements

• Hack Reactor
  • A special thank you to Hack Reactor!