🤝 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

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

⚗️ Usage & Examples

Signup/Login
Request or run an errand
Track your progress
Thank your neighbor
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

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