Skip to content

Latest commit

 

History

History
170 lines (110 loc) · 5.2 KB

README.md

File metadata and controls

170 lines (110 loc) · 5.2 KB
Raw

🚲 🚲 🚲

FixMyBerlin - A Mobility Platform for Berlin

Node.js CI

You can check out the live version at fixmyberlin.de.

fixmy screenshot

Contributing

Did you encounter an issue that you would like to tell us about? Would you like to add to this project yourself? Go ahead and check the contribution guide.

We use VSCode for as an IDE. It is recommended to do so.

Installation

We recommend using nvm to run this project with the Node version specified in .nvmrc.

npm install

Configuration

Configuration options for the app are set through environment variables (Using dotenv). You can set these by creating a file /.env in this directory. Look at the file .env.defaults to see how .env needs to be formatted. Default configuration options are also loaded from .env.defaults.

Production builds should always have BACKEND=production set in order to configure the correct API endpoint.

Development

Builds the application and starts a webserver with hot loading. Runs on localhost:8080

  • FixMyBerlin:

    npm start

  • Radbügel für Aachen:

    REGION=aachen npm start

    You can also set multiple environment variables when using an .env file. This then overwrites only the .env.defaults settings you enter. It could look like this:

    REGION=aachen
BACKEND=local

    It is then used by dotenv to setup configuration.

Testing

Runs unit tests.

npm test

# Run single test
npm test -- -t "filename.unit.test.js"

Build

Builds a minified version of the application in the build folder.

npm run build

Deployment

Each branch gets automatically deployed on netlify:

Debugging

In VSCode you can use the integrated debugging profiles for Chrome & Firefox to easily debug your code directly in Run and Debug section.

Embed Mode

The embed mode is for integration in other websites. This hides the main menu and changes other minor things in the UI.

You can test the embed mode by adding a query parameter to the url: http://localhost:8080/planungen?embed=1. There is also a deployed production version: https://embed.fixmyberlin.de/.

Run Tests

Unit tests

Run unit tests using npm run test.

End-To-End Tests

End-To-End tests are implemented using Cypress. There are a couple of options to run e2e tests. You can

  • start the dev server AND run tests headlessly in a single run npm run test:e2e-dev-server. This stops the dev server after all tests have been run.
  • run e2e tests headlessly against an already running development server using npm run test:e2e.
  • open the Cypress GUI and run tests in Chrome from there using npm run cypress

When you are working on e2e-tests for this app please also refer to the collection of notes from development of the end-to-end-test-suite in cypress/README.MD.

Internationalization

The platform has localization capabilities via format.js. This means that language, formatting and other options can be customized based on the localization of the current user. When strings are created using the format specific to format.js, translations can be made by extracting, translating and compiling the relevant text contents. Please refer to the format.js documentation for information on how to create React components that are suitable for translation.

Please note that IDs for translation strings are not automatically generated, as recommended by format.js documentation, but namespaced to the app or page the content is relevant for. Text for generic components is namespaced to components.

Each locale has a language code. This app currently supports:

  • German (de language code, default language)
  • English (en language code)
  • Spanish (es language code)

(1/3) Extracting

Extract text content for translation from the source code by running the command

npm run extract

This will update the file containing the German language default text contents in the file src/lang/translations/de.json.

(2/3) Translating

To create translations for the entries generated in the previous step, the relevant file need to be updated with the new translation keys manually.

  • src/lang/translations/en.json
  • src/lang/translations/es.json

(3/3) Compiling

Files in lang/translations need to be compiled into an optimized format stored in lang/compiled.

npm run compile

See also

There also Docs in the Gastro/ folder.