Lunes App

Android and iOS React native Apps for Lunes

If you are interested in contributing, please check out our wiki page.

Contents

• Getting Started
  • Prerequisites
  • Project setup
• Conventions
• Project Structure
• Further Reading

Getting Started

Prerequisites

• Rate our Lunes app in the PlayStore and the Apple App Store.
• Install nodejs.
• Install yarn.

Project setup

We suggest IntelliJ as IDE on Linux or Mac. If you are using a different IDE like Visual Studio Code, follow the steps here. If you want to develop on Windows, follow the steps here.

• Import this project (VCS > Get from Version Control) and open it.
• Run yarn in the terminal to install all dependencies.
• Take a look at the available scripts.

Android

• Install the Android SDK by using the Android Support plugin in IntelliJ.
• Install the latest stable SDK Platform and Android SDK Tools in the SDK Manager (Settings > Appearance & Behaviour > System Settings > Android SDK)
• [optional]: If you want to develop using an emulator, also install the Android Emulator in the Android SDK settings
• run yarn start and yarn android

iOS

• Own a Mac or another Apple device.
• Install XCode
• In /ios run bundle install and bundle exec pod install

Note: In order to work with the project in XCode, always open ios/Lunes.xcworkspace.

Additional Configuration

• [optional] Install the following plugins:
  • Styled Components
  • Ruby (if working with Fastlane)

Conventions

Our conventions can be found here

Further Reading

Documentation on CI/CD and more can be found in /docs.