Skip to content

Commit

Permalink
introduce environment configuration by default
Browse files Browse the repository at this point in the history
  • Loading branch information
p3t3r67x0 committed Feb 25, 2024
1 parent d9f6822 commit 797e10f
Show file tree
Hide file tree
Showing 10 changed files with 222 additions and 53 deletions.
1 change: 1 addition & 0 deletions .eslintrc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ root: true

env:
es6: true
node: true
browser: true

extends:
Expand Down
98 changes: 98 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Contributing

> Thank you for your interest in contributing to this OK Lab Flensburg project! We welcome contributions from the community to help improve #opendata #civictech and #opengovernment applications and prototypes. By contributing to this project, you are helping to make social demographic government data more accessible and usable for everyone.

## How to Contribute

We appreciate all types of contributions, including bug fixes, code improvements, documentation enhancements, and new features. To get started, follow these steps


#### Fork the Repository

Click the "Fork" button on the top right corner of this repository's page to create your own copy.


#### Clone the Repository

Clone your forked repository to your local machine using Git

```bash
git clone https://github.com/your-username/your-project.git
```


#### Create a Branch:

Create a new branch for your contribution. Choose a descriptive branch name

```bash
git checkout -b feature/your-feature-name
```


#### Make Changes

Make your desired changes to the codebase, documentation, or any other project files.

Test Your Changes: Test your changes to ensure they work as expected. If you're adding new features, make sure to document them properly.


#### Commit Your Changes

Commit your changes with a clear and concise commit message

```bash
git commit -m "Add your commit message here"
```


#### Push to Your Fork

Push your changes to your forked repository

```bash
git push origin feature/your-feature-name
```


#### Create a Pull Request

Go to the original repository and create a Pull Request (PR) from your forked branch to the main branch. Please provide a detailed description of your changes in the PR.


## Code Style and Guidelines

We follow specific code style and guidelines to maintain consistency in our codebase. Before submitting your contribution, please make sure to

- Write clear and concise code comments.
- Keep your PRs focused on addressing a single issue or implementing a specific feature.

By running `pnpm run lint`, you can ensure that your code complies with the project's style and formatting standards, making it easier for reviewers to evaluate your contributions.


## Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please report them on our Issue Tracker. When reporting issues, be sure to provide detailed information, including

- A clear description of the problem.
- Steps to reproduce the issue.
- Expected and actual behavior.
- Environment details (e.g., operating system, browser version, etc.).


## Community and Communication

We value open and respectful communication within our community. If you have questions or need assistance, you can

- Join our community in [slack](https://openknowledgegermany.slack.com) to discuss ideas or seek help.
- Reach out to the project maintainers via [email]([email protected]).


## License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

Thank you for contributing! Your efforts help make government data more transparent, accessible, and useful to citizens.

Happy coding!
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ _Haftungsausschluss: Dieses Repository und die zugehörige Datenbank befinden si




## Hintergrund

Die Idee, einen Kitafinder für Flensburg zu entwickeln, ist aus der eigenen Suche nach einer Kita für den Kleinen entstanden. Auf der [städtischen Website](https://www.flensburg.de/Kultur-Bildung/Bildungsb%C3%BCro/Kindertagesbetreuung/Kindertagesst%C3%A4tten) finden sich zwar Kontaktdetails zu den städtischen Kindertagesstätten und ein Link zu einer PDF Datei mit einer Liste aller Kindertagesstätten in Flensburg, jedoch fehlt eine übersichtliche Karte, die alle Kitas anzeigt. Aus dieser Fragestellung heraus ist diese Karte entstanden, um anderen Eltern die Suche nach einem Kitaplatz zu erleichtern.
Expand Down Expand Up @@ -45,6 +44,19 @@ git clone https://github.com/oklabflensburg/open-kita-map.git
Create dot `.env` file inside root directory. Make sure to add the following content repaced by your actual values

```
BASE_URL=http://localhost
[email protected]
CONTACT_PHONE="+49xx"
PRIVACY_CONTACT_PERSON="Firstname Lastname"
ADDRESS_NAME="Address Name"
ADDRESS_STREET="Address Street"
ADDRESS_HOUSE_NUMBER="House Number"
ADDRESS_POSTAL_CODE="Postal Code"
ADDRESS_CITY="City"
DB_PASS=postgres
DB_HOST=localhost
DB_USER=postgres
Expand Down
31 changes: 31 additions & 0 deletions src/env.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
export class Env {
constructor() {
this.origin = process.env.BASE_URL
this.contactMail = process.env.CONTACT_MAIL
this.contactPhone = process.env.CONTACT_PHONE
this.privacyContactPerson = process.env.PRIVACY_CONTACT_PERSON
this.addressName = process.env.ADDRESS_NAME
this.addressStreet = process.env.ADDRESS_STREET
this.addressHouseNumber = process.env.ADDRESS_HOUSE_NUMBER
this.addressPostalCode = process.env.ADDRESS_POSTAL_CODE
this.addressCity = process.env.ADDRESS_CITY
}

injectLinkContent(className, prepend, append, link, value) {
const nodes = document.querySelectorAll(className)

nodes.forEach((node) => {
node.href = `${prepend}${link}${append}`
node.innerHTML = value
})
}


injectTextContent(className, value) {
const nodes = document.querySelectorAll(className)

nodes.forEach((node) => {
node.innerText = value
})
}
}
File renamed without changes.
Loading

0 comments on commit 797e10f

Please sign in to comment.