Git Product home page Git Product logo

pass-culture-app-native's Introduction


Quality Gate Status Coverage

This project has been generated by react-native-make.

Getting Started

After installing node and yarn, run yarn install to install all the dependencies.

๐Ÿ“ฑ Mobile

To run the mobile app on Android or iOS, you will need to follow the installation steps:

๐Ÿ’ป Web

To run the web app on your browser, follow the steps here


Development

Debugging

We use Flipper to debug the network logs, react-query usage, layout, perfs... More info here.

Standards

In the doc/ folder you will find the dev standards the team members follow:

To add a dev standard

Standards can of course be improved and new ones can be added.

  1. Create a pull request with the standard modification/addition (use TEMPLATE.md for addition)
  2. Ask all team members to read your PR

Why: so that the team is aligned on how to code, and the best way to do something is shared within all members

  1. Make sure you got the approval of every member of the team
  2. You can merge :)

Testing

You can run the tests with yarn test. This command will:

  • Run eslint on your project
  • Check the typescript types
  • Run the jest tests

You can run the jest tests in watch mode with:

yarn jest --watch

You can also get the coverage with:

yarn jest --coverage

Local development

๐Ÿ“ Update the API schema If the backend changes the api schema, you will need to update it:
  • pull the swagger-codegen-cli-v3 image: docker pull swaggerapi/swagger-codegen-cli-v3
  • run: yarn generate:api:client

If the file src/api/gen/.swagger-codegen/VERSION changes, make sure you locally have the desired version of swagger-codegen-cli, otherwise run docker pull swaggerapi/swagger-codegen-cli-v3:3.0.24

To develop with a local API

See the docs to learn how to develop with a local API "superficially".

The other option, more complex, is to create a specific scheme 'Development' with a .env.development file : copy the .env.testing configuration and update the API_BASE_URL setting with you local server address.

Make sure you also overload the BATCH_API_KEY_ANDROID and BATCH_API_KEY_IOS variables with the dev values of the testing batch project.

Then copy testing.keystore into development.keystore and testing.keystore.properties into development.keystore.properties. Replace the storeFile value in development.keystore.properties.

test login credentials

In testing, you can use this test account to login:

See 1password for more test accounts.

Develop locally with id-check

To develop locally with id-check, please follow the instructions here.

โฌ‡๏ธ Download

To download the testing app, visit Appcenter for iOS and Android, or use this url. For the staging app, use these links for iOS and Android.

โš ๏ธ Make sure your device is registered in the device list.


Deployment

See doc about deployment process here for the mobile application.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.