Open source documentation app for the brave and true
This is the source code for Writeopia, an text edition App and SDK.
Writeopia is a project develop with Kotlin Multiplatform, most of the code is shared between all the apps. This is a project to save all your documents in one place providing you the freedom to choose where to store it. You can save your whole workspace with a button click and save it in git repository (like Github) or a storage system like Dropbox or Google Drive. A backend end is also understand develop so you can self host it and have full controll how you share your documentations with work teams and friends.
You can check the documentation of the project in the application documentation.
The sample app of the project is a great way to get a simple demo. You can have an experience like this those: https://sample.writeopia.io
You can check how to work locally if you would like to contribute with fixes, improvements or try Writeopia from source code.
Writeopia is a free project, so we would love your participation. Please check our issues and suggest changes before using the issues tab so we can evaluate and architecture new solutions together.
If you're looking for a place to get started you can look at:
- Issues with good first issue label
- Documentation for the project
- Bugs and other issues listed on GitHub
- Analise the apps and looks for new bugs.
Some useful commands for this project:
To start the desktop app:
./gradlew application:desktopApp:run
To start the web app:
./gradlew jsBrowserRun
Runnig the tests of the project:
./gradlew jvmTest
To start the android app use Android Studio.
The SDK allows you to create a text editor an use it instead of a simple TextField. You can use this library to create a better story editing experience within apps, such as social media (posts), travel logs, blog apps (like Medium), and chats (like Slack). By using this library, you can provide a great experience for editing text with media.
You can more in the SDK documentation