📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started

  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run Tests

• 👥 Author

• 🧾Documentation

• 🔭 Future Features

• 🤝 Contribution

• ⭐️ Show your support

• 🙏 Acknowledgements

• 📝 License

📖 Notes Backend API

** Notes Backend API** is a C# .Net Core RESTful API that performs CRUD operations, authentication, filtering, and sorting.

🛠 Built With

Tech Stack

C# .Net Core 9.0

Key Features

This is to practice C# .Net Core API, authentication, sorting and filtering.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Code editor like Visual Studio or Visual Studio Code
• Latest .NET SDK
• install SQL server

Setup

Clone this repository to your desired folder:

  cd your-folder
  git clone [email protected]:sawmon71293/notes-backend.git

Install

Installations:

• .NET SDK
• dotnet add package BCrypt.Net-Next --version 4.0.3
• dotnet add package Dapper --version 2.1.66
• dotnet add package Microsoft.ASPNetCre.Authentication.JwtBearer --version 8.0.0
• dotnet add package Microsoft.Data.SqlClient --version 6.1.0
• dotnet add package Swashbuckle.AspNetCore --version 6.6.2

Usage

• dotnet run

Run Tests

• no tests have been implemented yet.

👥 Author

👤 Saw Mon Han

• GitHub: @sawmon
• LinkedIn: LinkedIn

🧾 Documentation

• Microsoft dotnet
• Microsoft dotnet API
• MSTest
• xunit
• Dotnet Tips Jetbrains

🔭 Future Features

• For UI you can clone Nuxt4 front-end
• Tests to be implemented.
• Practice CI/CD and deployment.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please consider a star on GitHub!

(back to top)

🙏 Acknowledgments

I would like to thank myself for believing to dream big.

(back to top)

📝 License

This project is MIT licensed.

(back to top)