Mobile and Web application implementing Kiwi.com Tequila API
Switch branches/tags
Clone or download

README.md

Margarita

Margarita

Showcasing the power of Tequila

This project is a living example of a client app you could start building with Tequila.

Installing / Getting started

To get started, clone the repository, change directory and install the dependencies:

git clone git@github.com:kiwicom/margarita.git
cd margarita/
yarn install

To launch the graphql server:

  • yarn server

To launch the client app, you have different options:

  • yarn dev to launch the development web version;
  • yarn build; yarn start to launch the production web version;
  • yarn ios or yarn android to start the mobile version.

The other available scripts are:

  • yarn analyze to get an analysis of the bundle size to get the following yarn-analyze

  • yarn lint to ensure your code is properly formatted;

  • yarn flow to ensure your code is respecting the types given to your vaiables;

  • yarn test-ci to ensure your code should pass the Continuous Integration (CI) tests;

  • yarn relay to get the latest schema of the graphql server and compile your queries and fragments to generate Flow types, among other things.

Initial Configuration

@TODO

Developing

Considerations

This project follows react-native-web's philosophy of "Write Once, Render Anywhere". The web version is powered by Next.js and the mobile version is powered by Expo.

@TODO

Building

@TODO

Deploying / Publishing

CAVEAT: This is a demo app.

@TODO

Features

What's all the bells and whistles this project can perform?

  • Users can search and book flights; (@TODO)
  • Users can manage their bookings; (@TODO)

Configuration

Here you should write what are all of the configurations a user can enter when using the project.

@TODO

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

NOTE: Note this is only meant as an example app and even though we take pride in the quality of our work, features should not be assumed to be production-ready.

To ensure code quality, make sure to run yarn test-ci and fix the potential errors before pushing your code. See above for a description of what it does.

Links

Here are a few links that could be helpful:

Licensing

The code in this project is licensed under MIT license. By contributing to Margarita, you agree that your contributions will be licensed under its MIT license.