Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fossasia/open-event-organizer-ios

Open Event Orga iOS App
https://github.com/fossasia/open-event-organizer-ios

Last synced: 26 days ago
JSON representation

Open Event Orga iOS App

Awesome Lists containing this project

README 

        
## Open Event Organizer iOS App

> Event management app for organizers using Open Event Platform






## Roadmap



Make the app functionality and UI/UX similar to the [Android app](https://github.com/fossasia/open-event-orga-app) for Open Event Organizer.



## Communication



Please join our mailing list to discuss questions regarding the project: https://groups.google.com/forum/#!forum/open-event



Our chat channel is on gitter here: https://gitter.im/fossasia/open-event-ios



## Development



- A native iOS app.

- The [Open Event Organizer Server](https://github.com/fossasia/open-event-orga-server) acts as the backend for this application. The API docs for the same can be accessed at https://open-event-api-dev.herokuapp.com/ .

- The following account can be used for testing and development purposes:



  > **Email:** [email protected]



  > **Password:** fossasia

  

## Development Setup

> __This project is written in Swift 4.2 and Xcode 10 is required for development.__



Before you begin, you should already have the Xcode downloaded and set up correctly. You can find a guide on how to do this here: [Setting up Xcode](https://developer.apple.com/xcode/)



#####        Steps to install Cocoapods (one time installation)



- Run `sudo gem install cocoapods` to install the latest version of cocoapods. To install cocoapods from HomeBrew, `brew install cocoapods`.



-  Next, run `pod setup` for setting up cocoapods master repo. You may include `--verbose` for more descriptive logs.

**NOTE:** This might take a while to setup depending on your network speed.



## Setting up the iOS Project



1. Download the _open-event-orga-iOS_ project source. You can do this either by forking and cloning the repository (recommended if you plan on pushing changes) or by downloading it as a ZIP file and extracting it. OR

```

$ git clone https://github.com/fossasia/open-event-orga-iOS.git

```



2. Navigate to the unzipped folder and run `pod install`.



3. Open `EventyayOrganizer.xcworkspace` from the folder.



4. Build the project (⌘+B) and check for any errors.



5. Run the app (⌘+R).and test it.



## Branch Policy



**Note:** For the initialization period all commits go directly to the master branch. In the next stages we follow the branch policy as below:



We have the following branches

* **ipa**

All the automatic builds generates, i.e., the ipas go into this branch

* **master**

This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update, and make a release.

* **development**

All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to _development_.



## Code practices



Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics. 



* Single commit per pull request

* For writing commit messages please read the [COMMITSTYLE](docs/commit-style.md) carefully. Kindly adhere to the guidelines.

* Follow uniform design practices. The design language must be consistent throughout the app.

* The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.

* If the PR is related to any front end change, please attach relevant screenshots in the pull request description.

* Please follow the guides and code standards: [Swift Style Guide](https://google.github.io/swift/)

* Please follow the good iOS development practices: [iOS Good Practices](https://github.com/futurice/ios-good-practices)

* For contributors new to Git please have a look at the [Git Configuration commands](docs/git-configuration.md) .



## License



This project is currently licensed under the `Apache License Version 2.0`. A copy of [LICENSE](https://github.com/fossasia/open-event-orga-iOS/blob/master/LICENSE) should be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.