📝 X Notes 🚀

Welcome to X Notes! Your ultimate note-taking solution. Create, edit, and organize your notes effortlessly.

How to Install and Run Locally 🏠

Angular Web 🅰️

Before you begin, make sure you have the following prerequisites installed:

• Node.js: v18.18.2+
• Angular CLI: 17.0.1+
• Package Manager: npm 9.8.1+

1. Open Web -> Backend -> WebAPI -> Client
2. Install packages run: yarn
3. Run yarn start
4. Open your browser and go to localhost:4200

Backend .NET CORE | POSTGRESQL | Azure Storage | Redis (optional) 🖥️

Before you proceed, ensure you have the following prerequisites:

• .NET 8.0.100
• PostgreSQL
• Azure Storage (Azurite or cloud)

Here are the steps to set up the backend:

1. Open appsettings.development.json
2. Update the DatabaseConnection field with your database connection details.
3. If you don't have Redis, you can disable it by setting Redis:Active to false.
4. If you have your own Azure Blob Storage, update the Azure:Storages configuration with your values.
5. Clone the backend repository:
6. Open Web -> Backend
7. Migrate the database using the command line:
   1. dotnet ef database update --project DatabaseContext\DatabaseContext.csproj --startup-project WebAPI\WebAPI.csproj --context DatabaseContext.ApiDbContext
   2. Or use your favorite IDE tools for database migration.
8. Run WebAPI project

Support X Notes ☕

If you find X Notes helpful and would like to support our project, consider buying us a coffee. Your support is greatly appreciated!

Contributing 🤝

We welcome your contributions to make X Notes even better! Here's how you can get involved:

1. Track Bugs or Propose Features: Visit our Issues page to report bugs or suggest new features. Your feedback is valuable to us!

2. Code Contributions:

   • To contribute code, start by creating a branch from the DEV branch.

   • Naming your branch is important to help us understand its purpose:

     • For Bug Fixes, use: bugfix/github-issue-number.

     • For New Features, use: feature/github-issue-feature-number.

   • Submit your pull request when your changes are ready into DEV branch, and we'll review it promptly.

Let's collaborate and make X Notes even more awesome together! 🚀👩‍💻👨‍💻

Features

Notes

Folders

Base editor

Editor Audios

Editor photos

Editor videos

Editor documents

Notes Sharing

Folders sharing

Mobile Supported

Advanced personalization settings

User profile and feature for background changing

Unathorized folder view if folder shared.

Unathorized note view if note shared.

Labels

Selection mode

Search

White theme

Notifications

Discussion 💬

Join the conversation about X Notes on GitHub Discussions. Share your thoughts, suggestions, and feedback with the community.

License 📜

X Notes is distributed under the AGPLv3 License. See LICENSE.md for more information.

🎉 Happy Note-Taking with X Notes! 📝