This repository has been archived by the owner on Jun 10, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: (first iteration) README, LICENSE, logo
- Loading branch information
Robin Cussol
committed
Nov 30, 2018
1 parent
c202844
commit 8813997
Showing
5 changed files
with
125 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Kiwi.com | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,104 @@ | ||
TODO: | ||
|
||
- yarn workspaces | ||
|
||
![Margarita](assets/logo.png) | ||
|
||
# Margarita | ||
> Showcasing the power of [Tequila](https://partners.kiwi.com/presenting-tequila-revolution-travel-industry/) | ||
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: | ||
|
||
```shell | ||
git clone git@github.com:kiwicom/margarita.git | ||
cd margarita/ | ||
yarn install | ||
``` | ||
|
||
To launch the 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](assets/yarn-analyze.png) | ||
|
||
- `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](packages/graphql) | ||
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"](https://www.youtube.com/watch?v=HLWM2uhv2wI). The web version is powered by | ||
[Next.js](https://github.com/zeit/next.js/) and the mobile version is powered by | ||
[Expo](https://github.com/expo/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](#installing-/-getting-started) for a description of what it does. | ||
|
||
## Links | ||
|
||
Here are a few links that could be helpful: | ||
|
||
- Presenting Tequila: https://partners.kiwi.com/presenting-tequila-revolution-travel-industry/ | ||
- Tequila Portal: https://tequila.kiwi.com/portal | ||
- Repository: https://github.com/kiwicom/margarita/ | ||
- Issue tracker: https://github.com/kiwicom/margarita/issues | ||
- In case of sensitive bugs like security vulnerabilities, please contact | ||
tequila-support@kiwi.com directly instead of using issue tracker. We value your effort | ||
to improve the security and privacy of this project! | ||
- Awesome README starter: https://github.com/jehna/readme-best-practices | ||
|
||
|
||
## Licensing | ||
|
||
The code in this project is licensed under [MIT license](LICENSE). By contributing to Margarita, you agree that your contributions will be licensed under its MIT license. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters