README.md

Face the Facts

Contributing

This project is still in a very early stage. If you are interested in contributing, feel free to reach out to [email protected].

Development

npm needs to be installed to run this project

Run locally

git clone https://github.com/Face-the-Facts/mobile-app.git
cd mobile-app
npm install
npm start

Deployment

1. Build website with Docker

   • run following command and replace the secrets with the actual ID's

   docker build . -t app
   

   • don't know the secrets? ask your co-workers

2. Tag Image

   docker tag app facethefacts/app:<latest or develop>
   

3. Sign in into DockerHub

4. Push Docker Image

   docker push facethefacts/app:<latest or develop>
   

Automated Tests

We use a combination of testing frameworks to ensure functionality accross platforms and browsers

Unit & Integration Tests

We use the jest testing framework. Run these tests with npm test

E2E Tests

We use selenium for browser autmation in conjunction with the pytest framework. To run these tests, cd into the pytest directory. If you've never run the tests you'll need to configure the virtual environment and install dependencies:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

After this initial setup you can run the whole test suite with the command pytest

For more detailed information on supported platforms see E2E Testing