Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dahln/darknote

A simple open-source, minimalistic notes app
https://github.com/dahln/darknote

blazor blazor-webassembly dotnet notes notes-app open-source sqlite

Last synced: about 2 months ago
JSON representation

A simple open-source, minimalistic notes app

Host: GitHub
URL: https://github.com/dahln/darknote
Owner: dahln
License: mpl-2.0
Created: 2024-11-26T04:57:44.000Z (about 2 months ago)
Default Branch: master
Last Pushed: 2024-11-26T05:24:14.000Z (about 2 months ago)
Last Synced: 2024-11-26T06:25:13.406Z (about 2 months ago)
Topics: blazor, blazor-webassembly, dotnet, notes, notes-app, open-source, sqlite
Language: C#
Homepage: https://darknote.org
Size: 83 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

[![CI/CD](https://github.com/dahln/darknote/actions/workflows/dotnet-build-deploy.yml/badge.svg)](https://github.com/dahln/darknote/actions/workflows/dotnet-build-deploy.yml)

## What & Why
Darknote is a SaaS, open-source, user-friendly, minimal notes app. It allows users to create notes and lists and share notes and lists with other people.

Because this project is open-source, you can deploy this application how and where you want. You control the data.

## Demo
[https://darknote.org#HowTo](https://darknote.org#HowTo)

## Technologies
- .NET & C#
- Web API
- Blazor WASM
- Web API
- SQL (Sqlite)
- Identity API
- Identity API 2FA
- [Blazored Libraries (Toast, LocalStorage, Modal)](https://github.com/Blazored)
- [Bootstrap CDN (Bootstrap and Boostrap Icons)](https://getbootstrap.com/)

## Getting Started
You can run this project locally.

Requirements: You must have the [ASP.NET Core Runtime](https://dotnet.microsoft.com/en-us/download) installed.
1. Navigate to the project root folder
2. run this command: "dotnet watch --project .\Darknote.API\"
3. This command will startup the application and create the required Sqlite database file.
4. Register an account and sign-in.

## Deployment Instructions
A tutorial on deploying is coming soon.

## [SendGrid](https://sendgrid.com/en-us/pricing)
This project uses SendGrid to send emails. A SendGrid API key is required. You will need to specify your own SendGrid API key and system email address in the admin settings page. Some features that require email are not available until you provide the necessary SendGrid values. It is a simple process to create your own SendGrid account and retreive your API key.

## Why SQLite?
It runs on Windows and Linux. Moving and controlling your data is easy. If you need more than SQLite offers then I recommend switching to Azure SQL. If you switch to Azure SQL, besure to delete your SQLite DB migrations and create new a 'Initial Migration' for your new Azure SQL DB.

## Licensing
Refer to the LICENSE file