teikei
A web application that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data.
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
A web application that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data.
Basic Info
- Host: GitHub
- Owner: teikei
- License: agpl-3.0
- Language: JavaScript
- Default Branch: preview
- Homepage: https://ernte-teilen.org/karte
- Size: 44.7 MB
Statistics
- Stars: 62
- Watchers: 5
- Forks: 11
- Open Issues: 15
- Releases: 0
Topics
Metadata Files
README.md
Production
Preview
Teikei
Teikei is a web application and API that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data.
It is used by
- Ernte teilen
- Kooperationsstelle für solidarische Landwirtschaft
- Netzwerk für solidarische Landwirtschaft
Introduction
The repository is a monorepo consisting of 3 modules:
API /api
Teikei API is a Node application written with Feathers using Express as a server. It exposes a JSON REST API, data is stored in PostgreSQL. It also includes a job queue built with node-schedule.
Map /map
Teikei Map is a Single Page Application built with React and Redux. It was generated with the default create-react-app with added Sass support. Uses leaflet to display the map, feathers-client to connect to the API backend, joi for validation, superagent as a REST client.
Admin /admin
Teikei Admin allows content moderators and administrators to update and manage stored data. It connects to the same Teikei API backend application as the frontend module, but through separate Admin API endpoints. It's built with crudl.io, an open-source admin dashboard.
The monorepo makes use of npm workspaces and lerna and provides top-level scripts to run a complete Teikei application stack with a single command and to conveniently work with all 3 modules from a single repository.
Getting started
Requirements
Teikei requires node >= 18, npm and PostgreSQL >= 9.5.
Get the code
Clone the repository and install dependencies
javascript
git clone https://github.com/teikei/teikei
cd teikei
npm install
Configure project settings
You need to create an .env file in the root directory which contains the environment variables needed to run the project. The included .env.sample file lists the variables which need to be set.
Development Mode
Development mode will run the database in a Docker container and populate is with new test data on each run. Make sure you have Docker installed and running on your machine before starting the development server.
Running API / Map in development mode
- To start the map application in development mode run
npm run dev - The map frontend will be started at http://localhost:3000. The frontend express server runs on port 3000 and will proxy request to the API server on port 3030.
- The API server will run on http://localhost:3030
Or: Running API / Admin in development mode
- To start the admin application in development mode run
npm run dev-admin - The admin frontend will be started at http://localhost:4000. The frontend express server runs on port 3000 and will proxy request to the API server on port 3030.
- The API server will run on http://localhost:3030
Build for production
- Build the project for production with
npm run buildeither in the root directory to build all modules or individually in module subfolders. The build output will be copied to the /build folders of modules.
Test data
- To create initial data, run
npm run seed:runinside the /api folder - The command will create the following test users
| username | password | roles | | ---------------------- | -------- | ---------- | | superadmin@example.com | admin | superadmin | | admin@example.com | admin | admin | | user@example.com | admin | user |
This step will be performed automatically if you start a development server with npm run dev or npm run dev-admin.
Roadmap
We use Github to plan upcoming features and track bugs. If you want to participate, it's probably a good idea to look for open issues there. Before working on bigger features, however, it's advisable to get in contact with us, so that we can coordinate tasks and features.
Report a bug
Bugs, Issues and Feature requests can be added as issues here on Github. Please provide as much information as possible, including steps to reproduce the issue.
Authors & contributors
Alumni
- Tobias Preuss
- Daniel Mack
- Charis Braun
- Maria Dolecek
License
- The Teikei source code is released under the AGPL 3.0
- Assets in this repository are released under the Attribution-ShareAlike 4.0 International CC license
Owner
- Name: Teikei / ErnteTeilen
- Login: teikei
- Kind: organization
- Website: http://ernte-teilen.org
- Repositories: 2
- Profile: https://github.com/teikei
GitHub Events
Total
- Issues event: 1
- Watch event: 6
- Delete event: 93
- Issue comment event: 51
- Push event: 126
- Pull request review comment event: 20
- Pull request review event: 26
- Pull request event: 185
- Fork event: 1
- Create event: 92
Last Year
- Issues event: 1
- Watch event: 6
- Delete event: 93
- Issue comment event: 51
- Push event: 126
- Pull request review comment event: 20
- Pull request review event: 26
- Pull request event: 185
- Fork event: 1
- Create event: 92
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Christian Rijke | c****e@g****m | 1,076 |
| Christian Rijke | h****o@c****e | 926 |
| Simon Jockers | h****o@s****m | 531 |
| Tobias Preuss | t****s@g****m | 530 |
| Daniel Mack | z****e@g****m | 53 |
| dependabot[bot] | 4****] | 22 |
| dependabot-preview[bot] | 2****] | 5 |
| depfu[bot] | 2****] | 1 |
| Thibaud Guillaume-Gentil | t****d@t****g | 1 |
| Philipp Tessenow | p****p@t****g | 1 |
| Knut Hühne | k****t@k****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 14
- Total pull requests: 499
- Average time to close issues: about 1 year
- Average time to close pull requests: about 1 month
- Total issue authors: 4
- Total pull request authors: 5
- Average comments per issue: 0.14
- Average comments per pull request: 0.65
- Merged pull requests: 166
- Bot issues: 0
- Bot pull requests: 338
Past Year
- Issues: 1
- Pull requests: 224
- Average time to close issues: less than a minute
- Average time to close pull requests: 7 days
- Issue authors: 1
- Pull request authors: 4
- Average comments per issue: 0.0
- Average comments per pull request: 0.45
- Merged pull requests: 98
- Bot issues: 0
- Bot pull requests: 109
Top Authors
Issue Authors
- sjockers (5)
- crijke (5)
- tantebootsy (3)
- milahu (1)
Pull Request Authors
- dependabot[bot] (335)
- crijke (158)
- dependabot-preview[bot] (3)
- sjockers (2)
- thibaudgg (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 5
-
Total downloads:
- npm 37 last-month
-
Total dependent packages: 6
(may contain duplicates) -
Total dependent repositories: 4
(may contain duplicates) - Total versions: 61
- Total maintainers: 1
proxy.golang.org: github.com/teikei/teikei
- Documentation: https://pkg.go.dev/github.com/teikei/teikei#section-documentation
- License: agpl-3.0
-
Latest release: v0.7.0
published over 10 years ago
Rankings
npmjs.org: @teikei/schemas
Teikei validation schemas. Teikei is the software that powers ernte-teilen.org, a website that maps out Community-supported Agriculture in Germany.
- Homepage: http:
- License: AGPL-3.0
-
Latest release: 0.0.7
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: @teikei/api
Teikei API server. Teikei is the software that powers ernte-teilen.org, a website that maps out Community-supported Agriculture in Germany.
- Homepage: http:
- License: AGPL-3.0
-
Latest release: 0.0.7
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: @teikei/map
Teikei map SPA component. Teikei is the software that powers ernte-teilen.org, a website that maps out Community-supported Agriculture in Germany.
- Homepage: http:
- License: AGPL-3.0
-
Latest release: 0.0.7
published over 7 years ago
Rankings
Maintainers (1)
npmjs.org: @teikei/migrations
Teikei data migrations. Teikei is the software that powers ernte-teilen.org, a website that maps out Community-supported Agriculture in Germany.
- Homepage: http:
- License: AGPL-3.0
-
Latest release: 0.0.7
published over 7 years ago