Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rwth-acis/RequirementsBazaar-WebFrontend
Requirements Bazaar, the continuous innovation platform. Repository of the single-page Web application using Web Components, made with love in Aachen, Germany.
https://github.com/rwth-acis/RequirementsBazaar-WebFrontend
Last synced: 5 days ago
JSON representation
Requirements Bazaar, the continuous innovation platform. Repository of the single-page Web application using Web Components, made with love in Aachen, Germany.
- Host: GitHub
- URL: https://github.com/rwth-acis/RequirementsBazaar-WebFrontend
- Owner: rwth-acis
- License: other
- Created: 2014-10-23T13:07:35.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T17:29:12.000Z (7 months ago)
- Last Synced: 2024-10-01T13:02:32.639Z (about 1 month ago)
- Language: Vue
- Homepage: https://requirements-bazaar.org
- Size: 17.8 MB
- Stars: 14
- Watchers: 28
- Forks: 5
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - rwth-acis/RequirementsBazaar-WebFrontend - Requirements Bazaar, the continuous innovation platform. Repository of the single-page Web application using Web Components, made with love in Aachen, Germany. (others)
README
# Requirements Bazaar Frontend
This is the Vue3 based implementation of the Requirements Bazaar Frontend.
- Vue 3
- Vuex 4
- Vue Router 4
- PrimeVue 3
- Vite 4
- Typescript
- SASS
## Set up Development Environment
Install dependencies:
```
npm install
```
We use [Vite](https://vitejs.dev/) for frontend tooling.
To start the development server, use:
```
npm run dev
```
## Local Backend
To use a local Requirements Bazaar backend during development use:
```
npm run dev-local-api
```
## Build
There are multiple commands to build the frontend for different environments.
To build for the *beta environment*, use:
```
npm run build-beta
```
To build for the *production environment*, use:
```
npm run build-prod
```
If you want to deploy your own instance of the Requirements Bazaar, provide an environment configuration `.env.my-environment` and use:
```
npm run build -- --mode my-environment
```
## API Types Generation
The following commands have to be executed only after the backend API has been updated. Normally, the
current generated API is already checked into the repository in the `/src/types` folder.
```
npx swagger-typescript-api -p https://beta.requirements-bazaar.org/bazaar/swagger.json -o ./src/types -n bazaar-api.ts --route-types
npx swagger-typescript-api -p https://beta.requirements-bazaar.org/activities/swagger.json -o ./src/types -n activities-api.ts --route-types
```
## Exprimental Features
The following features are implemented for evaluation, but not yet enabled by default.
### Down Votes
Down votes are disabled by default. Use the `VITE_DOWN_VOTES_ENABLED=false` variable in the environment file to enable the feature.