Genau! (API)

What is Genau ?

A simple mobile web app to learn German. Just click here and test it by yourself !

What does contain this repository ?

This repository contains only the services of the app. If you want to access to the UI repository, please go to the genau repository.

Do you want to contribute ?

Thanks to GitHub (I just love what you are doing guys ❤️), to contribute is quite easy !

# Clone this project
git clone git@github.com:thinow/genau-api.git

# Change directory
cd genau-api

# Fetch the npm dependencies
npm install

# Run the development server
npm run start

# Run the tests
npm run test

You can send me your modifications by creating a pull request.

How to run the integration tests ?

This project contains some end-to-end test which assume that a running MongoDB server is running in local.

To help you to set up the data, you can use this command line :

mongoimport -h localhost:27017 -d genau -c question --file ./test/resources/question.dump

How to report a bug ?

If you've seen any problem by using the app, please create a new issue. Many thanks !

License

This project is licensed under the terms of the MIT license