Prizy

Prizy is a mobile app, built in React-Native, that will help automate the prize draws during our meetup. Attendees will have the ability to check in and enter the draw.

More features will be added in the future.

Requirements

Be sure to check the official React Native Guide.

1. NodeJS (version 8.3 or newer)
2. Watchman - if you are on macOS. Watchman is a tool by Facebook for watching changes in the filesystem. It is highly recommended you install it for better performance.
3. React Native cli - react-native-cli
4. Xcode (optional - to run the app on iOS)
5. Android Studio (optional - to run the app on Android)
6. react-native-debugger (optional - but very nice to have, for debugging react components and redux store)

Getting started

1. Install node modules

Run npm install from root directory

2. Run on simulators

1. Start server to serve React Native code
   • react-native start or npm run start
2. Start iOS simulator
   • react-native run-ios
3. Start Android emulator
   • react-native run-android

Backend

The app will consume data from a RESTful API. For more details, please, check the community's backend project.

Project management

Currently, there is a trello board available, with a backlog of user stories. In addition to that board, GitHub issues will be used to track bugs, feature requests and more.

Contribution

If you are new to Open Source, please, read this introduction.

In a nutshell, you can follow these steps:

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Sync your fork (see how)
5. Push your work back up to your fork
6. Submit a Pull request so that we can review your changes