Collective App
Project Description Our project aims to assist newcomers, local groups, and parents by addressing challenges in accessing information about their local environment. It provides comprehensive, centralized details about communities, including cultural offerings, public services, and activities, enhanced by visual tools like maps and graphs. Unlike fragmented information sources, our solution fosters a sense of belonging by connecting users to events, opportunities and community engagement.
System Requirements
- Node.js version 18 or higher
- npm version 8 or higher.
- MongoDB installed and running.
Installation and Running
Frontend
- Navigate to the Frontend directory: cd Collective/frontend
- Install dependencies: npm install
- Start the local server: npm start
Backend
-
Navigate to the Backend directory: cd Collective/backend
-
Install dependencies: npm install
-
Create a .env file in the root Backend directory with the following content:
PORT=3000 MONGO_URI=mongodb://localhost:27017/collective JWT_SECRET=your_secret_key
-
Start the server: npm start
Tools and Technologies
Frontend:
- React
- React Router
- Zustand
- Chart.js
- Material-UI
- Google Maps API
Backend:
- Node.js
- Express
- MongoDB
- Socket.io
- JWT for user authentication
Basic Usage
- Open your browser and navigate to:
- Frontend: http://localhost:3001
- The Frontend app is connected by default to the Backend server using a proxy.
Important Notes
- To use the Google Map, ensure you provide a valid API key in the Frontend configuration file.
- Automated tests are available in the Frontend via npm test.
Git Code This file and the entire project code are available on GitHub under [Collective]. To clone the repository: git clone [https://github.com/Liz-Vainer/Collective.git]