Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve introduction section of README #32

Merged
merged 2 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Contributor Licence Agreement (CLA)

- [Individual contributor](#1-individual-contributor)
- [On behalf of an organization, foundation, company or other entity, which may have multiple contributors](#2-organization-foundation-company-or-other-entity)

## 1. Individual contributor

You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Delta10 B.V.. Except for the license granted herein to Delta10 B.V. and recipients of software distributed by Delta10 B.V., You reserve all right, title, and interest in and to Your Contributions.

### 1.1 Definitions

"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Delta10 B.V.. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Delta10 B.V. for inclusion in, or documentation of, any of the products owned or managed by Delta10 B.V. (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Delta10 B.V. or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Delta10 B.V. for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."

### 1.2 Grant of Copyright License

Subject to the terms and conditions of this Agreement, You hereby grant to Delta10 B.V. and to recipients of software distributed by Delta10 B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.

### 1.3 Grant of Patent License

Subject to the terms and conditions of this Agreement, You hereby grant to Delta10 B.V. and to recipients of software distributed by Delta10 B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.

You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Delta10 B.V., or that your employer has executed a separate Corporate CLA with Delta10 B.V..

### 1.4 Contributions

You represent that each of Your Contributions is Your original creation. You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.

Should You wish to submit work that is not Your original creation, You may submit it to Delta10 B.V. separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: (insert_name_here)".

You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.

You agree to notify Delta10 B.V. of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.

This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office.

## 2. Organization, foundation, company or other entity

You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Delta10 B.V.. Except for the license granted herein to Delta10 B.V. and recipients of software distributed by Delta10 B.V., You reserve all right, title, and interest in and to Your Contributions.

### 2.1 Definitions

"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Delta10 B.V.. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"Contribution" shall mean the code, documentation or other original works of authorship, including any modifications or additions to an existing work, that is submitted by You to Delta10 B.V. for inclusion in, or documentation of, any of the products owned or managed by Delta10 B.V. (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Delta10 B.V. or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Delta10 B.V. for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."

### 2.2 Grant of Copyright License

Subject to the terms and conditions of this Agreement, You hereby grant to Delta10 B.V. and to recipients of software distributed by Delta10 B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.

### 2.3 Grant of Patent License

Subject to the terms and conditions of this Agreement, You hereby grant to Delta10 B.V. and to recipients of software distributed by Delta10 B.V. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.

You represent that You are legally entitled to grant the above license. You represent further that each of Your employees is authorized to submit Contributions on Your behalf, but excluding employees that are designated in writing by You as "Not authorized to submit Contributions on behalf of (name of Your corporation here)." Such designations of exclusion for unauthorized employees are to be submitted via email to `[email protected]`. It is Your responsibility to notify Delta10 B.V. when any change is required to the list of designated employees excluded from submitting Contributions on Your behalf. Such notification should also be sent via email to `[email protected]`.

### 2.4 Contributions

You represent that each of Your Contributions is Your original creation.

Should You wish to submit work that is not Your original creation, You may submit it to Delta10 B.V. separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: (named here)".

You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.

This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

We – [Delta10 B.V.](https://www.delta10.nl/) and the maintainers of this project – know we can only build together with you. Thus we appreciate your input, enjoy feedback and welcome improvements to this project and are very open to collaboration.

By contributing to this project, you accept and agree the the terms and conditions as specified in the [Contributor Licence Agreement](CLA.md).

## Problems, suggestions and questions in Issues

You don't need to change any of our code or documentation to be a contributor. Please help development by reporting problems, suggesting changes and asking questions. To do this, you can create an issue for this project in the [issues section](https://github.com/delta10/signalen-frontend-wcag).

## Documentation and code in Pull Requests

If you want to add to the documentation or code of one of our projects you should push a branch and make a Pull Request.

### 1. Make your changes

This project uses the **OneFlow branching model** and workflow. When you've forked this repository, please make sure to create a feature branch following the OneFlow model. Read this [short blogpost](http://endoflineblog.com/oneflow-a-git-branching-model-and-workflow) when you're not yet familiar with OneFlow.

Add your changes in commits [with a message that explains them](https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message). Document choices or decisions you make in the commit message, this will enable everyone to be informed of your choices in the future.

If you are adding code, make sure you've added and updated the relevant documentation and tests before you submit your Pull Request. Make sure to write tests that show the behaviour of the newly added or changed code.

### 2. Pull Request

When submitting the Pull Request, please accompany it with a description of the problem you are trying to address and the issue numbers that this Pull Request fixes/addresses.

### 3. Improve

All contributions have to be reviewed by someone.

It could be that your contribution can be merged immediately by a maintainer. However, usually, a new Pull Requestneeds some improvements before it can be merged. Other contributors (or our automatic testing system) might have feedback. If this is the case the reviewing maintainer will help you improve your documentation and code.

If your documentation and code have passed human review and have passed the automated tests, it is merged.

### 4. Celebrate

Your ideas, documentation and code have become an integral part of this project.

---

For more information on how to use and contribute to this project, please read the [`README`](README.md).
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
We're developing a new frontend for the notification form section of https://signalen.org. Our goals are to achieve an 'A' accessibility status, provide multi-language support, and make the frontend easily customizable (colors, texts, etc.) by mounting a single config.json file with chosen municipality variables into the production container.
We ([Delta10](https://www.delta10.nl) and [Frameless](https://www.frameless.io)) are developing a new web form for [Signalen](https://www.signalen.org), an open source application for municipalities for reports about the public space.

Our goals are to:

- be fully compliant with WCAG2.1 AA (Toegankelijkheidsstatus A);
- support [NL Design System](https://nldesignsystem.nl);
- and have multi-language support.

The frontend can easily be customized by configuring a single JSON file.

## Getting started as a developer
First, run the npm install command.

First, install the dependencies:

```bash
npm install
```

Set the environment variables in a ```.env``` or ```.env.local``` file.
Set the environment variables in a ```.env``` or ```.env.local``` file:

```bash
NEXT_PUBLIC_BASE_URL_API=http://127.0.0.1:8000
NEXT_PUBLIC_MAPTILER_API_KEY=your_maptiler_api_key_here
NEXT_PUBLIC_MAPTILER_MAP=your_maptiler_map_url_here
```

Run the next development server
Then run the Next development server:

```bash
npm run dev
# or
Expand All @@ -23,7 +36,7 @@ pnpm dev
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Open [http://localhost:3000](http://localhost:3000) with your browser to see the application.

## Techniques
We’ve decided to use [Next.js](https://nextjs.org) with the App Router for this application. Alongside that, we’re utilizing [Radix UI](https://www.radix-ui.com/) for components and [React Hook Form](https://react-hook-form.com/) for form logic, validation, and more. For object validation, we’re using [Zod](https://zod.dev/), and for global state management, we rely on [zustand](https://zustand-demo.pmnd.rs/). Additionally, we’re incorporating [next-intl](https://next-intl-docs.vercel.app/) for internationalization (i18n), enabling multi-language support in the frontend.