Welcome to Archeio

Archeio is a personal note-taking app designed to help you organize your thoughts and ideas seamlessly. Built on the Quarkus Java runtime environment and deployed on Google Kubernetes Engine (GKE), Archeio offers an efficient platform for all your note-taking needs.

How to Use Archeio

Sign In Using GitHub OAuth2

1. Select GitHub for Authentication:

   • Click on the "Sign in" button. This will redirect you to the GitHub OAuth2 authentication page.

2. Authorize Archeio:

   • If prompted, log in to your GitHub account.

   • Authorize Archeio to access your GitHub account by clicking "Authorize".

3. Complete Sign-In:

   • You will be redirected back to Archeio, now signed in with your GitHub account.

Add a Folder on the Left Sidebar Menu

1. Locate the Sidebar:

   • On the main dashboard, find the left sidebar menu where your folders and notes are listed.

2. Add a New Folder:

   • Look for an "Add Folder" button or a "+" icon at the top or bottom of the sidebar.

   • Click on this button to create a new folder.

   • Enter a name for your new folder in the dialog that appears.

   • Confirm to add the folder to the sidebar.

Add Subfolders via the Breadcrumbs Create Button

1. Navigate to the Parent Folder:

   • Click on the parent folder where you want to add a subfolder. This will open the folder and show its contents.

2. Use the Breadcrumbs Create Button:

   • At the top of the folder view, you will see a breadcrumb navigation bar.

   • Next to the breadcrumb path, there should be a "Create" button or a "+" icon.

   • Click on this button to create a new subfolder.

3. Enter Subfolder Details:

   • Enter the name of the subfolder in the dialog that appears.

   • Confirm to add the subfolder under the selected parent folder.

Tag a Post by Typing a #tag in the Rich Text Editor

1. Open the Rich Text Editor:

   • Create a new note or open an existing one where you want to add tags.

2. Add Tags in the Editor:

   • While typing your note, you can create a tag by typing # followed by the tag name (e.g., #important).

   • The editor should automatically recognize the # symbol and format it as a tag.

3. Manage Tags:

   • Tags will appear as part of the note content. You can click on them to see all notes with the same tag or to edit them.

Contributing

We welcome contributions from the community! Here are a few ways you can get involved:

• Report Bugs: If you find a bug, please open an issue.

• Submit Pull Requests: We accept pull requests for new features, bug fixes, and improvements.

• Improve Documentation: Help us improve our documentation by making it clearer and more comprehensive.

Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all. Please read and adhere to our Code of Conduct.

Contact

If you have any questions, feel free to reach out to us:

• Email: thecynicdog0328@gmail.com

• GitHub: github.com/CynicDog/archeio

Thank you for your interest in Archeio! We look forward to collaborating with you.

#archeio