neon443/NearFuture
1
0
Fork 0
mirror of https://github.com/neon443/NearFuture.git synced 2026-03-11 06:49:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Nihaal Sharma
2024-12-25 23:16:07 +00:00
committed by GitHub
parent 6387d300fd
commit 35bb7c43ad
1 changed files with 45 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@@ -1 +1,45 @@
# NearFuture Near Future is a SwiftUI App to help people to track upcoming events - Holidays, Trips, Birthdays, Weddings, Anniversaries ## Roadmap - [x] Add and delete events - [x] Descriptions - [x] Icons - [ ] Event colors - [ ] Recurrence - [x] Search - [ ] Home Screen Widgets - [ ] Lock Screen Widgets ## Features - **Event Creation**: Create events with a name, description, date, recurrence, and an icon - **Symbol Picker**: Choose an icon for your event using an SF Symbol Picker - **Recurring Events**: Set events to repeat daily, weekly, monthly, or yearly - **Search Functionality**: Quickly find events using the search bar - **Persistence**: Events are saved locally and loaded on app launch via UserDefaults - **Animations**: Smooth animations - what more can I say lol ## Compiling ### Prerequisites - **Xcode 15+** - **iOS 17+** (if planning to install to a physical device) 1. Clone the repository and open the `.xcodeproj`: ```bash git clone https://github.com/your-repo/NearFuture.git cd NearFuture open NearFuture.xcodeproj ``` 2. In the Project, Under Targets and under Signing & Capabilities, select your Team ID and change the Bundle ID 3. In `Product > Destination` Select your iOS device or Simulator 4. Hit `Command + R` to Build and Run the Project ## Contributing Contributions are welcome! just follow these: 1. Follow [#Compiling] to get a copy on your machine 2. Optionally create a feature branch for your additions 3. Open a pull request ## Used Tools/Frameworks - Swift & SwiftUI - Apple - **SFSymbolsPicker** - [alessiorubicini/SFSymbolsPickerForSwiftUI].
# NearFuture
Near Future is a SwiftUI App to help people to track upcoming events - Holidays, Trips, Birthdays, Weddings, Anniversaries
## Roadmap
- [x] Add and delete events
- [x] Descriptions
- [x] Icons
- [ ] Event colors
- [ ] Recurrence
- [x] Search
- [ ] Home Screen Widgets
- [ ] Lock Screen Widgets
## Features
- **Event Creation**: Create events with a name, description, date, recurrence, and an icon
- **Symbol Picker**: Choose an icon for your event using an SF Symbol Picker
- **Recurring Events**: Set events to repeat daily, weekly, monthly, or yearly
- **Search Functionality**: Quickly find events using the search bar
- **Persistence**: Events are saved locally and loaded on app launch via UserDefaults
- **Animations**: Smooth animations - what more can I say lol
## Compiling
### Prerequisites
- **Xcode 15+**
- **iOS 17+** (if planning to install to a physical device)
1. Clone the repository and open the `.xcodeproj`:
```bash
git clone https://github.com/your-repo/NearFuture.git
cd NearFuture
open NearFuture.xcodeproj
```
2. In the Project, Under Targets and under Signing & Capabilities, select your Team ID and change the Bundle ID
3. In `Product > Destination` Select your iOS device or Simulator
4. Hit `Command + R` to Build and Run the Project
## Contributing
Contributions are welcome! just follow these:
1. Follow [#Compiling] to get a copy on your machine
2. Optionally create a feature branch for your additions
3. Open a pull request
## Used Tools/Frameworks
- Swift & SwiftUI - Apple
- **SFSymbolsPicker** - [alessiorubicini/SFSymbolsPickerForSwiftUI].