Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kosasih/cityai
CityAI Microservice Project is designed to address the challenges faced by modern cities in managing diverse systems and processes.
https://github.com/kosasih/cityai
city city-builder city-government smartcity
Last synced: 10 days ago
JSON representation
CityAI Microservice Project is designed to address the challenges faced by modern cities in managing diverse systems and processes.
- Host: GitHub
- URL: https://github.com/kosasih/cityai
- Owner: KOSASIH
- License: mit
- Created: 2023-06-20T16:42:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-13T08:16:17.000Z (over 1 year ago)
- Last Synced: 2024-04-16T11:01:27.160Z (8 months ago)
- Topics: city, city-builder, city-government, smartcity
- Language: Java
- Homepage: https://kosasih.github.io/CityAi/
- Size: 514 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CityAI Microservice Project
Welcome to the CityAI Microservice Project! This project aims to provide a scalable and modular solution for managing various aspects of a city's operations through the use of microservices. Each microservice focuses on a specific domain within a city, enabling easy integration, deployment, and maintenance.
## Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
4. [Usage](#usage)
5. [API Documentation](#api-documentation)
6. [Contributing](#contributing)
7. [License](#license)
## Introduction
CityAI Microservice Project is designed to address the challenges faced by modern cities in managing diverse systems and processes. By breaking down complex city operations into smaller, specialized microservices, this project provides a scalable and flexible architecture that can be extended and customized based on specific city requirements.
The project follows a microservice-based approach, where each microservice focuses on a specific domain, such as transportation, waste management, energy optimization, public safety, or urban planning. This allows individual services to be developed, deployed, and scaled independently, promoting better maintainability and agility.
## Features
The CityAI Microservice Project offers the following key features:
1. **Modularity**: Each microservice operates independently, allowing for easy integration and maintenance.
2. **Scalability**: Services can be scaled individually based on demand, ensuring efficient resource utilization.
3. **Flexibility**: The project provides an extensible architecture, enabling the addition of new services and integration with existing systems.
4. **Interoperability**: Microservices communicate through well-defined APIs, enabling seamless data exchange between different domains.
5. **Real-time Data Processing**: The project incorporates real-time data processing capabilities, enabling efficient decision-making and response to city events.
6. **Analytics and Insights**: Services provide analytics and insights to aid city administrators in making data-driven decisions.
## Getting Started
To get started with the CityAI Microservice Project, follow the instructions below.
### Prerequisites
1. **Operating System**: The project is compatible with Windows, macOS, and Linux.
2. **Node.js**: Ensure that Node.js is installed on your system. You can download it from [https://nodejs.org](https://nodejs.org).
3. **Package Manager**: The project uses npm as the package manager. npm is bundled with Node.js.
### Installation
1. Clone the project repository:
```shell
git clone https://github.com/cityai-microservices/cityai.git
```
2. Navigate to the project directory:
```shell
cd cityai
```
3. Install the project dependencies:
```shell
npm install
```
## Usage
To start using the CityAI Microservice Project, follow these steps:
1. Start the desired microservice by running the following command:
```shell
npm run start:
```
2. Access the microservice API through the provided endpoint. Refer to the API documentation for details on available endpoints and request/response formats.
3. Integrate the microservice with other services or systems as required, using the provided API.
## API Documentation
For detailed information about the API endpoints and their functionalities, refer to the [API documentation](/docs/api).
## Contributing
Contributions to the CityAI Microservice Project are welcome! If you want to contribute, please follow the guidelines outlined in the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
## License
The CityAI Microservice Project is licensed under the
MIT License. For more information, please refer to the [LICENSE](/LICENSE) file.
## Roadmap
The future development of the CityAI Microservice Project includes the following planned features and enhancements:
- Integration with IoT devices for real-time data collection.
- Implementation of advanced analytics and machine learning algorithms for predictive insights.
- Enhancements to security measures, including authentication and authorization mechanisms.
- Integration with external data sources and APIs to enrich the functionality and data coverage.
- Continuous integration and deployment pipelines for automated testing and deployment.
- Development of a web-based dashboard for monitoring and managing microservices.
- Support for containerization technologies, such as Docker and Kubernetes, for easier deployment and scalability.
We welcome contributions and ideas from the community to help shape the future direction of the project.
## Support
If you encounter any issues or have questions regarding the CityAI Microservice Project, please feel free to [open an issue](https://github.com/cityai-microservices/cityai/issues) on the project repository. We will be glad to assist you.
## Acknowledgments
We would like to express our gratitude to the open-source community for their invaluable contributions and inspirations that have made this project possible. We also extend our thanks to all the developers and organizations whose libraries, frameworks, and tools are utilized in this project.
## About
The CityAI Microservice Project is developed and maintained by a team of passionate developers dedicated to creating innovative solutions for urban management. It is an open-source project aimed at empowering cities with intelligent and efficient systems.
For more information about the project and its contributors, visit the [official website](https://cityai-microservices.com).
## Stay Connected
To stay updated with the latest news and announcements regarding the CityAI Microservice Project, you can:
- Follow us on Twitter: [@cityai_micro](https://twitter.com/cityai_micro)
- Join our community on Discord: [CityAI Comunity](https://discord.gg/Tgpabg4m)
- Visit our blog: [CityAI Blog](https://cityai-microservices.com/blog)
We encourage you to engage with the community, share your feedback, and contribute to the project's growth and success.
Thank you for choosing the CityAI Microservice Project! We hope it provides valuable solutions for managing and improving cities.
## Project Structure
Node is required for generation and recommended for development. `package.json` is always generated for a better development experience with prettier, commit hooks, scripts and so on.
In the project root, JHipster generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.
`/src/*` structure follows default Java structure.
- `.yo-rc.json` - Yeoman configuration file
JHipster configuration is stored in this file at `generator-jhipster` key. You may find `generator-jhipster-*` for specific blueprints configuration.
- `.yo-resolve` (optional) - Yeoman conflict resolver
Allows to use a specific action when conflicts are found skipping prompts for files that matches a pattern. Each line should match `[pattern] [action]` with pattern been a [Minimatch](https://github.com/isaacs/minimatch#minimatch) pattern and action been one of skip (default if ommited) or force. Lines starting with `#` are considered comments and are ignored.
- `.jhipster/*.json` - JHipster entity configuration files
- `npmw` - wrapper to use locally installed npm.
JHipster installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using `./npmw` instead of the traditional `npm` you can configure a Node-less environment to develop or test your application.
- `/src/main/docker` - Docker configurations for the application and services that the application depends on
## Development
Before you can build this project, you must install and configure the following dependencies on your machine:
1. [Node.js][]: We use Node to run a development web server and build the project.
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
After installing Node, you should be able to run the following command to install development tools.
You will only need to run this command when dependencies change in [package.json](package.json).
```
npm install
```
We use npm scripts and [Angular CLI][] with [Webpack][] as our build system.
If you are using hazelcast as a cache, you will have to launch a cache server.
To start your cache server, run:
```
docker compose -f src/main/docker/hazelcast-management-center.yml up -d
```
Run the following commands in two separate terminals to create a blissful development experience where your browser
auto-refreshes when files change on your hard drive.
```
./mvnw
npm start
```
Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by
specifying a newer version in [package.json](package.json). You can also run `npm update` and `npm install` to manage dependencies.
Add the `help` flag on any command to see how you can use it. For example, `npm help update`.
The `npm run` command will list all of the scripts available to run for this project.
### PWA Support
JHipster ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.
The service worker initialization code is disabled by default. To enable it, uncomment the following code in `src/main/webapp/app/app.module.ts`:
```typescript
ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),
```
### Managing dependencies
For example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:
```
npm install --save --save-exact leaflet
```
To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:
```
npm install --save-dev --save-exact @types/leaflet
```
Then you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:
Edit [src/main/webapp/app/app.module.ts](src/main/webapp/app/app.module.ts) file:
```
import 'leaflet/dist/leaflet.js';
```
Edit [src/main/webapp/content/scss/vendor.scss](src/main/webapp/content/scss/vendor.scss) file:
```
@import 'leaflet/dist/leaflet.css';
```
Note: There are still a few other things remaining to do for Leaflet that we won't detail here.
For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].
### Developing Microfrontend
Microservices doesn't contain every required backend feature to allow microfrontends to run alone.
You must start a pre-built gateway version or from source.
Start gateway from source:
```
cd gateway
npm run docker:db:up # start database if necessary
npm run docker:others:up # start service discovery and authentication service if necessary
npm run app:start # alias for ./(mvnw|gradlew)
```
Microfrontend's `build-watch` script is configured to watch and compile microfrontend's sources and synchronizes with gateway's frontend.
Start it using:
```
cd microfrontend
npm run docker:db:up # start database if necessary
npm run build-watch
```
It's possible to run microfrontend's frontend standalone using:
```
cd microfrontend
npm run docker:db:up # start database if necessary
npm watch # alias for `npm start` and `npm run backend:start` in parallel
```
### Using Angular CLI
You can also use [Angular CLI][] to generate some custom client code.
For example, the following command:
```
ng generate component my-component
```
will generate few files:
```
create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts
```
### JHipster Control Center
JHipster Control Center can help you manage and control your application(s). You can start a local control center server (accessible on http://localhost:7419) with:
```
docker compose -f src/main/docker/jhipster-control-center.yml up
```
### Doing API-First development using openapi-generator-cli
[OpenAPI-Generator]() is configured for this application. You can generate API code from the `src/main/resources/swagger/api.yml` definition file by running:
```bash
./mvnw generate-sources
```
Then implements the generated delegate classes with `@Service` classes.
To edit the `api.yml` definition file, you can use a tool such as [Swagger-Editor](). Start a local instance of the swagger-editor using docker by running: `docker compose -f src/main/docker/swagger-editor.yml up -d`. The editor will then be reachable at [http://localhost:7742](http://localhost:7742).
Refer to [Doing API-First development][] for more details.
## Building for production
### Packaging as jar
To build the final jar and optimize the CityAi application for production, run:
```
./mvnw -Pprod clean verify
```
This will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.
To ensure everything worked, run:
```
java -jar target/*.jar
```
Then navigate to [http://localhost:8081](http://localhost:8081) in your browser.
Refer to [Using JHipster in production][] for more details.
### Packaging as war
To package your application as a war in order to deploy it to an application server, run:
```
./mvnw -Pprod,war clean verify
```
## Testing
To launch your application's tests, run:
```
./mvnw verify
```
### Client tests
Unit tests are run by [Jest][]. They're located in [src/test/javascript/](src/test/javascript/) and can be run with:
```
npm test
```
### Other tests
Performance tests are run by [Gatling][] and written in Scala. They're located in [src/test/java/gatling/simulations](src/test/java/gatling/simulations).
You can execute all Gatling tests with
```
./mvnw gatling:test
```
For more information, refer to the [Running tests page][].
### Code quality
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
```
docker compose -f src/main/docker/sonar.yml up -d
```
Note: we have turned off forced authentication redirect for UI in [src/main/docker/sonar.yml](src/main/docker/sonar.yml) for out of the box experience while trying out SonarQube, for real use cases turn it back on.
You can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) or by using the maven plugin.
Then, run a Sonar analysis:
```
./mvnw -Pprod clean verify sonar:sonar -Dsonar.login=admin -Dsonar.password=admin
```
If you need to re-run the Sonar phase, please be sure to specify at least the `initialize` phase since Sonar properties are loaded from the sonar-project.properties file.
```
./mvnw initialize sonar:sonar -Dsonar.login=admin -Dsonar.password=admin
```
Additionally, Instead of passing `sonar.password` and `sonar.login` as CLI arguments, these parameters can be configured from [sonar-project.properties](sonar-project.properties) as shown below:
```
sonar.login=admin
sonar.password=admin
```
For more information, refer to the [Code quality page][].
## Using Docker to simplify development (optional)
You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the [src/main/docker](src/main/docker) folder to launch required third party services.
For example, to start a postgresql database in a docker container, run:
```
docker compose -f src/main/docker/postgresql.yml up -d
```
To stop it and remove the container, run:
```
docker compose -f src/main/docker/postgresql.yml down
```
You can also fully dockerize your application and all the services that it depends on.
To achieve this, first build a docker image of your app by running:
```
npm run java:docker
```
Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:
```
npm run java:docker:arm64
```
Then run:
```
docker compose -f src/main/docker/app.yml up -d
```
When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental `Use the new Virtualization framework` for better processing performance ([disk access performance is worse](https://github.com/docker/roadmap/issues/7)).
For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (`jhipster docker-compose`), which is able to generate docker configurations for one or several JHipster applications.
## Continuous Integration (optional)
To configure CI for your project, run the ci-cd sub-generator (`jhipster ci-cd`), this will let you generate configuration files for a number of Continuous Integration systems. Consult the [Setting up Continuous Integration][] page for more information.
[JHipster Homepage and latest documentation]: https://www.jhipster.tech
[JHipster 8.0.0-beta.1 archive]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1
[Doing microservices with JHipster]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/microservices-architecture/
[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/development/
[Service Discovery and Configuration with the JHipster-Registry]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/microservices-architecture/#jhipster-registry
[Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/docker-compose
[Using JHipster in production]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/production/
[Running tests page]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/running-tests/
[Code quality page]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/code-quality/
[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/setting-up-ci/
[Node.js]: https://nodejs.org/
[NPM]: https://www.npmjs.com/
[Webpack]: https://webpack.github.io/
[BrowserSync]: https://www.browsersync.io/
[Jest]: https://facebook.github.io/jest/
[Leaflet]: https://leafletjs.com/
[DefinitelyTyped]: https://definitelytyped.org/
[Angular CLI]: https://cli.angular.io/
[Gatling]: https://gatling.io/
[OpenAPI-Generator]: https://openapi-generator.tech
[Swagger-Editor]: https://editor.swagger.io
[Doing API-First development]: https://www.jhipster.tech/documentation-archive/v8.0.0-beta.1/doing-api-first-development/