Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teikei/teikei
A web application that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data.
https://github.com/teikei/teikei
crowdsourcing csa javascript leafletjs nodejs react
Last synced: about 1 month ago
JSON representation
A web application that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data.
- Host: GitHub
- URL: https://github.com/teikei/teikei
- Owner: teikei
- License: agpl-3.0
- Created: 2014-05-14T17:25:12.000Z (over 10 years ago)
- Default Branch: preview
- Last Pushed: 2024-10-24T20:41:23.000Z (about 2 months ago)
- Last Synced: 2024-10-30T03:41:38.331Z (about 1 month ago)
- Topics: crowdsourcing, csa, javascript, leafletjs, nodejs, react
- Language: JavaScript
- Homepage: https://ernte-teilen.org/karte
- Size: 43.8 MB
- Stars: 57
- Watchers: 6
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-open-ror - Teikei - A web application for managing groups and farmers following the idea of community-supported agriculture. (Community-support)
- open-sustainable-technology - Teikei - A web application and API that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data. (Consumption / Agriculture and Nutrition)
- awesome-starred - teikei/teikei - A web application that maps out community-supported agriculture in Germany, Switzerland, and Austria, based on crowdsourced data. (react)
README
**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](https://ernte-teilen.org)
- [Kooperationsstelle für solidarische Landwirtschaft](https://www.solawi.ch)
- [Netzwerk für solidarische Landwirtschaft](https://www.solidarische-landwirtschaft.org)
## Introduction
The repository is a monorepo consisting of 3 modules:
### API /api
Teikei API is a [Node](https://nodejs.org/en/) application written with [Feathers](https://feathersjs.com/) using [Express](https://expressjs.com/) as a server. It exposes a JSON REST API, data is stored in [PostgreSQL](https://www.postgresql.org/). 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](https://github.com/facebook/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](https://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 build`either 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:run` inside the /api folder
- The command will create the following test users
| username | password | roles |
| ---------------------- | -------- | ---------- |
| [email protected] | admin | superadmin |
| [email protected] | admin | admin |
| [email protected] | 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
- [Simon Jockers](https://github.com/sjockers)
- [Christian Rijke](https://github.com/crijke)
## Alumni
- [Tobias Preuss](https://github.com/johnjohndoe)
- [Daniel Mack](https://github.com/zonque)
- Charis Braun
- Maria Dolecek
## License
- The Teikei source code is released under the [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.html)
- Assets in this repository are released under the [Attribution-ShareAlike 4.0 International CC license](http://creativecommons.org/licenses/by-sa/4.0/)