https://github.com/juditkaramazov/summercodefest-plantyourlife
☀️ SCF - Plant your life encourages to take care of your... plants? Roommates? Both?
https://github.com/juditkaramazov/summercodefest-plantyourlife
json-server react-native typescript
Last synced: 7 months ago
JSON representation
☀️ SCF - Plant your life encourages to take care of your... plants? Roommates? Both?
- Host: GitHub
- URL: https://github.com/juditkaramazov/summercodefest-plantyourlife
- Owner: JuditKaramazov
- Created: 2023-10-29T00:55:44.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-29T15:28:24.000Z (about 2 years ago)
- Last Synced: 2025-03-22T17:13:19.805Z (7 months ago)
- Topics: json-server, react-native, typescript
- Language: TypeScript
- Homepage:
- Size: 8.95 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# "Summer Code Fest": Plan(t) Your Life
This is a [React Native](https://reactnative.dev/) project working with [`create-expo-app`](https://expo.dev/); that is why I highly encourage you to install `Expo Go` on your mobile device instead of using the browser. This way, you will get an accurate idea of the app that I had in mind while losing the mental sanity that I had left.
## Getting Started
First, clone the repository:
```bash
$ git clone https://github.com/JuditKaramazov/SummerCodeFest-PlantYourLife.git
```
Then, execute the API we'll be using as a json-server:
```bash
$ json-server --watch src/services/server.json --host YOUR_IP --port 3333
```
As a note, we'll incorporate the same information in our ./services/api.ts file, which should look as follows: `http://YOUR_IP:3333`. Then, simply run the development server:
```bash
$ npx expo start
```
And use the QR code in order to access the application on `Expo Go`.
## Introduction
Although I am fully aware we're already finishing October and soon we will all immerse ourselves in a vibe that only Majora's Mask could replicate, this project is still part of the `Summer Code Fest` (check out my [Spotify Replica](https://github.com/JuditKaramazov/SummerCodeFest-Spotify) or [M. Pomodoro Rajoy Timer](https://github.com/JuditKaramazov/SummerCodeFest-M.Pomodoro-Rajoy) to learn more!), and it aims at practicing the basics I couldn't explore during my formation. In this case, and since one of the main topics affecting my life these last months has been gravitating around the idea of moving out with this teammate of mine (`happy birthday` again!), I decided to create an application focused on the one and only reality we should all embrace and rely on as functional adults: `plants`.
- Just like roommates, they are the perfect allies whenever our scenarios change so drastically - and just like them, they require `time`, `nutrients` and the `proper environment`.
- They can be as small and portable just as our dearly beloved `mobile devices`.
- Above all, they force us to stick to a well-organized lifestyle, and nothing works better for it than `reminders` and `notifications`.
Considering this, and since I wanted to keep learning and practicing `TypeScript` independently of my external circumstances, creating a customized `React Native` application inspired by my new condition, my roommate's passion for plants, and our overall lack of time management felt like the only possible solution. Why `React Native`, though? In all honesty, and due to the convoluted nature of our daily lives, it seemed appropriate to make `Plan(t) Your Life` fit inside our pockets; this way, we won't forget to pay attention to what truly matters to us.
## Features & Style
After clarifying some relevant matters regarding this unstable, chaotic and unpredictable essence of ours, allow me to explain what's the content you'll find by accessing this repository:
- The possibility to `create an account` and keep track of the user's selected options.
- A collection of `several plants` and `environments`, each one with their own particularities and preferences.
- Some not-so-accurate descriptions of... human beings? Plants? Both?
- A customizable alarm allowing the user to `manage the watering time` of their plants by `notifying` them on their phones.
- A `private section` (called `My Plants`) displaying the user's `selected reminders`. If these reminders are not necessary anymore, there's a possibility to `delete` them.
- A bunch of bad jokes, puns and tons of courage for the ones struggling with a new reality.
As for the `images` that I decided to incorporate, my intention was to properly capture a cheerful spirit that would not have been possible to recreate without [Freepik](https://www.freepik.com/)'s amazing artists and contributions. As usual, thank you so much for such incredible art!
On the other hand, I highly encourage you to give [Screely](https://screely.com/) or [Mockuper](https://mockuper.net/generator) a try for your mockups and screenshots.
Please note that while I'm trying my best to improve and explore different technologies, tools and possibilities, there might be some inconsistencies, bugs and errors that will surely be addressed in the future.
Do not hesitate to let me know about it, though!