NorkaServer is the server component for a note-taking app called Norka. It provides a fast and secure way to sync your note library between devices.
Built using ASP.NET Core and SQLite, NorkaServer offers a user-friendly interface for managing and accessing notes. Leveraging the power of Entity Framework Core, it ensures seamless database access. The API documentation is generated using Swagger, simplifying the understanding and interaction with the provided endpoints. The project adheres to the GitHub Community Guidelines and the GNOME Code of Conduct to foster a friendly and inclusive environment for all contributors.
This project is built on top of the following technologies:
- ASP.NET Core: A high-performance, open-source framework for building cloud-based, connected applications.
- SQLite: A lightweight, serverless, file-based database engine that is widely used in web development.
- Entity Framework Core: A powerful ORM (Object-Relational Mapping) framework that simplifies database access and allows developers to work with databases using C# code.
- Swagger: A tool for generating API documentation from code annotations.
To build and run the project, follow these steps:
- Clone the repository:
git clone https://github.com/tenderowl/norkaserver.git - Navigate to the project directory:
cd norkaserver - Restore the project dependencies:
dotnet run --project Norka.API
We are committed to providing a friendly, safe, and welcoming environment for all, regardless of background or identity. Please refer to the GitHub Community Guidelines for the detailed code of conduct for our project.
We welcome contributions to our project. To contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure the code lints successfully.
- Submit a pull request with a clear description of your changes.
- Your pull request will be reviewed, and once approved, it will be merged into the main branch.
Thank you for considering contributing to our project!