Milieu

Milieu is a comprehensive community interaction app that serves as a bridge between small businesses, sole proprietors, and community members. It offers an intuitive and interactive map tool to help users discover and engage with the businesses and events around them. Built with a robust Sequelize backend and a responsive React frontend, it promises a seamless user experience.

Table of Contents

• Features
• Demo Video
• Screenshots
• Quick Start
• Backend Setup
• Technology Stack - Dependencies
• Contribution
• License
• Contact
• Thank You

Features 🌟

• Interactive Map Tool: Integrated with Google Maps API to facilitate easy and smooth location navigation.
• Business & Event Creation: Allows registered users to create and edit their business profiles and events, making real-time updates accessible to the community.
• Community Engagement: Enables users to explore the vibrant activities and livelihoods happening in their locale.

Demo Video 🎥

MilieuDemo.1.mp4

Screenshots 📸

Quick Start 🚀

Frontend Setup

1. Navigate to the frontend folder.
2. Run npm install to install all necessary dependencies.
3. Obtain a Google Map API key and set up your .env file with the following configurations:

REACT_APP_MAPSKEY='your Google Map API key'
REACT_APP_API_BASE_URL=http://localhost:3001/api/
REACT_APP_API_KEY='your geoapify API key'

4. Start the client with npm start. The frontend client will run on port 3000 and connect to the database server, rendering the Milieu app in your browser.

Backend Setup 🖥️

1. Navigate to the backend folder.
2. Run npm install to install all necessary dependencies.
3. Configure your PostgreSQL database with the following settings:
   • User: development
   • Password: development
   • Database: milieu
   • Host: localhost
4. Set up your .env file with the following configurations:

DB_USER=development
DB_PASS=development
DB_NAME=milieu
DB_HOST=localhost

5. Seed the database by running npm run db:reset in the backend directory.
6. Start the server with npm start. The backend will run on port 3001.

Technology Stack 🛠️

Dependencies

To run Milieu successfully, ensure you have the following dependencies installed:

• Node 12.22.12 or higher
• PostgreSQL 9.x
• React 18.2.0
• Axios 1.5.0
• Bcryptjs 2.4.3
• Sequelize 6.32.1 (for the backend)

You can find more dependencies in the package.json files in both the frontend and backend directories.

Contribution

We welcome contributions to improve the Milieu app. Feel free to contact us if you want to contribute.

License

Contact the Creators

Alex Tamayo

• LinkedIn: Alex Tamayo
• GitHub: AlexTamayo

Alex Broughton

• LinkedIn: Alex Broughton
• GitHub: AlexWBroughton

Filipe Moscovo

• LinkedIn: Filipe Moscovo
• GitHub: Fmoscovo

Thank you for considering Milieu for your community interaction needs. We hope it serves as a robust tool to foster vibrant and active community engagements.