lakshay-saini-au8 / party-planner

Party Planner App

This is the repository of our PP app, PP stands for Party planner . This app is designed to streamline the process of organizing events and trips. By using our app, users can conveniently register for party or trip services, enabling them to access the expertise of top event organizers in their respective cities. Our app aims to alleviate the burdensome task of event planning, allowing users to focus on celebrating even the smallest occasions while saving valuable time.

Tech Stack

React Native, Kotlin, TypeScript, StyleSheet

About the Project

This Project serves the cross-platform-app. This project is built in React-Native/Kotlin.

PRD

Product Requirement Doc

Figma

Figma design

First Phase

• Phone number Authentication
• Dashboard, profile
• Dashboard features
• Profile features
• User can check their favourite event/trip planner via location.
• Can check thier profile and vice versa.

Prerequisites

• React Native setup
• Android Studio
• Node setup

NOTE : Make sure to set up the proper development environment required to run react-native applications.

You can refer : https://reactnative.dev/docs/environment-setup

Local App setup

• First set up with React native environment on your local machine. You can refer the Environment Setup Link
• If you have done the first point then congrats 🎉now you are good to go !
• Now clone the mobile app Repo with Github Repo Link
• Run the command - Yarn.
• Start contributing.

Contribution Guide

For React-Native

• You must have all the pre-requisites which are mentioned above.

• Go through the issues and comment on the one which you like.

• When an issue is assigned to you then just follow all the local App setup steps and you are good to do😊

• Before pushing the code make sure you follow the below 👇steps

  • Make sure you run the app on your local machine. It should not give any errors.
  • Run yarn run precommit-check
  • then Run your git commands to push your code.
  • Make sure to give a proper commit message.

• If you need any other help, feel free to ping on mobile-app-react-native channel at discord.

Git commands for local setup:

• git clone https://github.com/Real-Dev-Squad/mobile-app.git
• cd mobile-app
• yarn

Git commands to commit your code:

• git checkout -b 'your PR name'
• git add .
• git commit -m "message"
• git push origin your PR name

TDD

• All the PRs should be raised with the 100% test coverage.
• Before submitting the PRs you should run the command yarn test to check if all the tests are passed or not.

Running/Development

• yarn react-native start - to start Metro, the JavaScript bundler that ships with React Native.
• Let Metro Bundler run in its own terminal. Open a new terminal inside your React Native project folder. Run the following:
• yarn react-native run-android - To start the emulator.