search

BijoySingh / Scarlet-Notes

[Discontinued and Unsupported Project] Simple yet powerful rich note taking android application, with a lot of flexibilty of usage
https://play.google.com/store/apps/details?id=com.bijoysingh.quicknote
GNU General Public License v3.0
358 stars 95 forks source link

Adding important guideline documents #95

Open santoshhiremani opened 6 years ago

santoshhiremani commented 6 years ago

Hi, May I contribute some interesting documentation for this project, like setup documentation, code of conduct, code contribution and Bug reports guidelines.

lcukerd commented 6 years ago

That is what I was actually looking for. Can you share the format of data on firebase? That will help me a lot and save from reading the code.

BijoySingh commented 6 years ago

@santoshhiremani Sure that would be great.

@lcukerd As you can imagine, the app is not meant for a full setup given its opensource and has firebase.. but I will share the database config later so if you have your own firebase account you can still test it on it. If you are testing features not touching firebase the app build target should still build as it doesnt need firebase.

lcukerd commented 6 years ago

@BijoySingh I don't know what you mean by full setup. I will be building an electron app to go with this for myself (It will open source so you are also welcome to use). I will be needing the structure of firebase database and formatting of data done before uploading to implement this in electron. Tell me the class that is responsible for this (if that's how your architecture is), I will give it a look.

BijoySingh commented 6 years ago

@lcukerd I already have a webpage https://scarlet.maubis.com/ which works based on the firebase specs. I will open source it and you can help move it to electron? It will be easier to have one source for the web/electron client right?

The class you are looking for is: scarlet/src/main/java/com/bijoysingh/quicknote/firebase/data/FirebaseNote.kt

Though the logic in the description is not trivial.

lcukerd commented 6 years ago

@BijoySingh Thankyou for sharing the file path. This is what I was looking for.

Yes, it will be easier to maintain one source but actually, I need a specific minimalist UI (Windows sticky note but synced cross-platform). I am not looking for complex features but minimal features to take notes faster. Had it to not been for my craving for this UI I would have used any other cross-platform note app and not bothered with development. I chose Scarlet notes because of its UI similarity with sticky notes. I am sorry I cannot contribute in moving it to electron as of now (probably later once I am done with my projects).