Plany

Plany is a small mobile application built with React Native and Expo.

Overview

Plany is designed to provide users with calendar event tracking functionalities.

Requirements

• Node version 20.3.1
• pnpm version 8.14.0 or higher
• Android Studio or XCode to build and run the app on your device

Setup

To get started with Plany, follow these steps:

1. Clone the repository:

   git clone https://github.com/Said-Alisic/Plany.git
   cd plany

2. Install dependencies:

   pnpm install

3. Run the application:

   iOS

   pnpm run ios

   Android

   pnpm run android

💡 This will start the Expo server in your terminal. You can then run the app on an emulator or scan the QR code with the Expo Go app on your mobile device.

⚠️ You may need to open your emulator yourself if Expo doesn't do it automatically or it fails to run the first time before the emulator opens.

Features

❗️Some features are missing business logic and only have dummy implementations ready.

Sign In

PlanySignInVideo.mov

Sign In feature video

Signing in using email and password. Additionally, possible to sign in using a social provider such as Gmail.

Sign Up

PlanySignUpVideo.mov

Sign Up feature video

Signing up using email and password. Additionally, possible to sign up using a social provider such as Gmail.

Calendar

PlanyCalendarVideo.mov

Calendar feature video

Checking events through a calendar. Creating new and deleting existing events in addition to displaying detailed event information for selected events.

Settings

PlanySettingsVideo.mov

Settings feature video

Adjusting application settings, such as language, dark or light mode, and enabling or disabling notifications.

Upcoming features ✨

Feature	Type	Status
Authentication through API	feat 🎸	In progress 🟡
Create new calendar event	feat 🎸	In progress 🟡
Add participants to existing calendar event	feat 🎸	Planning ⚪️
Add component tests with Cypress	test 💍	Planning ⚪️
Setup continuous integration tests workflow	ci 🎡	Planning ⚪️
Delete existing calendar event	feat 🎸	Planning ⚪️
Remove calendar event participant(s)	feat 🎸	Planning ⚪️
Beautified calendar events section	design 💅	In progress 🟡
Access calendar event information	feat 🎸	Planning ⚪️
Create custom app colour theme	design 💅	Planning ⚪️

License

Plany is open-source software licensed under the MIT License.