Skip to content

Open-Source Mobile App for tree style categorizing of your "saved messages"

License

Notifications You must be signed in to change notification settings

turing228/YourLib

Repository files navigation

YourLib

How often do you save important information by sending it to yourself on social networks and forget to use it?

Cross-platform open-source project YourLib based on React Native framework lets you categorize immediately it in a tree-style (e.g. ”school”, ”work”, ”home” and in each ”events”, ”links”, ”books”) and sync it with Google Firebase cloud.

Use Cases or Questions to You

  1. How do you store all .pdf textbooks or links to them? It's Mathematical Analysis, Probability Theory, Discrete Mathematics, Economics, History, Foreign Language and a lot of other textbooks!
  2. Do you like to cook? How do you don't forget all amazing recipes, lifehacks?
  3. How do you remember everything what is not written anywhere on the Internet? For example: nice bars, night clubs, places for walking with you friends

This application is designed to solve these and other your problems!

Contents

🚀 Quickstart

Clone this repository :

git clone https://github.com/turing228/YourLib.git
cd YourLib

Install packages :

yarn install

Set up Firebase to be used with React Native application according to official instruction

Create Firebase Realtime Database with rules from file database_rules.txt

When the installation is complete, run with a version of your choice :

react-native run-ios
# or
react-native run-android

🍔 Screenshots

Main Pages

All Pages!

Click to view all screenshots!

First Pages

Registration

Create Directories

Create Subdirectories

Create Notes

All Notes Screen

Remove Subdirectory

Remove Directory

All Notes Screen Again

🚄 Roadmap

Version Feature/Action Description Date
0.1 User Interface Skeleton ✔️25.10.2019
Create default project ✔️25.10.2019
Implement tab navigation for "directories" and "all notes" ✔️25.10.2019
Make the main screen: directories, their circle avatars, and subdirectories list ✔️25.10.2019
Make the main screen: clickable subdirectories ✔️25.10.2019
Make the main screen: add new directory button and the special screen ✔️25.10.2019
Make the main screen: add new subdirectory button and the special screen ✔️25.10.2019
Make the inside a subdirectory screen: hide topTabBar ✔️25.10.2019
Make the inside a subdirectory screen: subdirectory data transfer from directories screen to specific subdirectory screen ✔️25.10.2019
Make the inside a subdirectory screen: gifted chat UI ✔️25.10.2019
Make the inside a subdirectory screen: goback arrow in the header ✔️25.10.2019
Make "all notes" screen ✔️25.10.2019
Make screenshots and add them to the repository ✔️25.10.2019
-- -- --
0.2 Cloud Sync and a lot of UI-work ✔️29.10.2019
UI: Bullet points in subdirectories list ✔️26.10.2019
UI: Ability to delete directories or subdirectories ✔️26.10.2019
UI: Alert before permanently deleting ✔️26.10.2019
UI: Sidebar navigation (between home and settings) ✔️26.10.2019
Spaghetti Code ✔️26.10.2019
Fix spaghetti code (restructure project architecture) ✔️28.10.2019
Connect Firebase auth with the project ✔️26.10.2019
UI: Make registration by mobile number screens ✔️26.10.2019
UI: Make simple settings screen to check whether you signed in or not with sign in and sign out functionality ✔️26.10.2019
UI: Global font sizes ✔️28.10.2019
Connect Firebase realtime database with the project ✔️28.10.2019
Write rules for the realtime database to store "notes" ✔️28.10.2019
Store/download/sync data with the realtime database: add and remove directories ✔️29.10.2019
Store/download/sync data with the realtime database: add and remove subdirectories ✔️29.10.2019
Store/download/sync data with the realtime database: add notes ✔️29.10.2019
All Notes Screen ✔️29.10.2019
Enable Firebase Database offline capabilities for Mobile app ✔️28.10.2019
Make new screenshots and add them to the repository ✔️29.10.2019
-- -- --
unplanned Feel free to implement this or suggest something new and make a pull request!
Make the color-theme selectable
Implement functionality for adding new notes via "Share" button
"Add image"
Image synchronization with the Amazon Database or other image hosting
Implement nice fast-preview/view of links
Choosing icons/colors for directories
Nice animation from "edit" icon to "check" icon
Hide top bars during scrolling
Editing/removing notes
Whole directory screen
Delete account button
Current sync status
"Create your first directory" scenario
Nice events-view (& ability to add to google calendar)
Nice tab navigation between subdirectories inside a directory
Ability to reorder FlatLists (of directories and subdirectories)
Connect react-native-firebase and libs for iOS version of app
Ability to download all notes as a .json file
Ability to download all notes as a .excel file
Implement the report/feedback system
-- -- --
in future Kickstarter Сampaign
Implement smart Machine Learning based suggestions of categorizing
Implement smart advertisement based on notes (like subscriptions to news websites)
Website
Desktop application

The main purpose of the Kickstarter campaign is to confirm the demand for a solution and scale significantly following the wishes of you, users!

🏆 Motivation

Here are just the first two slides of the business presentation. Check it for more details!

📸 Concept

📋 Technologies

👪 Contributors

You are welcome! We have roadmap of planned changes - just pick any task you want, implement it and make a pull request! Or write an issue to discuss problems and ideas.

Current contributors list:

Nikita Lisovetin, student of ITMO University, Department of Computer Technologies. Developer.

📄 License

YourLib is GNU GPL licensed, as found in the LICENSE file.