Skip to content

Commit

Permalink
Merge pull request #36 from UNopenGIS/restore-readme
Browse files Browse the repository at this point in the history
Restore README.md
  • Loading branch information
yuiseki committed Jun 15, 2024
2 parents 0e9cc09 + b2229c4 commit d48efca
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 22 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
tmp
!tmp/.gitkeep
**/tmp
!**/tmp/.gitkeep

.vite

# Logs
logs
*.log
Expand Down
50 changes: 28 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
# React + TypeScript + Vite
# FOIL4G: Free and Open Information Library for Geospatial

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Concept

Currently, two official plugins are available:
We incorporate Benjamin Franklin’s library concept into the idea of the Free and Open Information Library for Geospatial (FOIL4G):

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
> "Since our books were often referred to in our disquisitions upon the queries, it might be convenient to have them all together where we meet, so that they might be consulted when needed. Additionally, by pooling our books into a common library, we would, while we liked to keep them together, have the advantage of using the books of all the other members, which would be nearly as beneficial as if each owned the whole."
## Expanding the ESLint configuration
This quote is highly relevant to emphasize the philosophy behind FOIL4G. FOIL4G aims to create an open library of geospatial information, allowing all members to freely access and collaboratively utilize the data. By doing so, it leverages individual resources to enhance the collective knowledge and capabilities of the entire community.

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
Specifically, FOIL4G can incorporate the following elements:

- Configure the top-level `parserOptions` property like this:
1. **Aggregation of Shared Resources**: Collect smart maps, geospatial data, relevant documents, and more in one place where everyone can access them.
2. **Collaborative Work and Learning**: Facilitate discussions among members, enabling them to consult necessary information on the spot for effective decision-making and problem-solving.
3. **Expansion of Knowledge**: By utilizing the shared library, each member can benefit from the knowledge and resources of others, thus enhancing their own capabilities.

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```
In this way, FOIL4G applies Benjamin Franklin’s library concept to modern geospatial information systems, providing a platform where all participants can cooperate and grow together.

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
## Goals

- Create and provide a library of freely accessible geospatial data for everyone.
- Develop and provide a library of skills and recipes for handling those data.
- Facilitate effective decision-making and problem-solving through the sharing of that information.
- Promote the automatic processing of geospatial information by generative AI through the sharing of that information.

## Implementation

- `lib`
- `api`: API for accessing geospatial information
- `data`: Details for referencing geospatial information
- `skills`: Skills for handling geospatial information
- `tasks`: Tasks for processing and analyzing geospatial information

## Contributing

Interested in contributing to FOIL4G? We welcome contributions of all kinds from anyone. Please see our [CONTRIBUTING.md](CONTRIBUTING.md) file for more details on how to submit bug reports, feature requests, and pull requests. For more information on our Code of Conduct, please refer to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.

0 comments on commit d48efca

Please sign in to comment.