Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 2.19 KB

README.md

File metadata and controls

113 lines (74 loc) · 2.19 KB

NOTAION

Demo

https://notaion.onrender.com/

Table of Contents

  1. Overview
  2. Features
  3. Technologies Used
  4. Screenshots
  5. Installation
  6. Usage

Overview

Fast note for dev

Features

  • Create personal notes
  • Real-time private messaging with SignalR integration
  • User profiles with customizable avatars
  • Friend request management (add, accept, decline)
  • Online/offline user tracking
  • Responsive design for mobile and desktop views

Technologies Used

Back-end:

  • ASP.NET Core Web API (ver 7.0)
  • SignalR for real-time functionality
  • Entity Framework for data management

Front-end:

  • ReactJS
  • Ant Design for UI components
  • TailwindCSS for styling

Database:

  • SQL Server

Supporting Tools:

  • Docker
  • Git

CI/CD:

  • Jenkins
  • Azure Sandbox
  • Github Actions

Screenshots

Main Page

Main Page

Private Chat

Private Chat

Profile Page

Profile Page

List Pages

List Pages

Content View

Content View

Installation

  1. Clone the repository:

    git clone https://github.com/mtai0524/notaion.git

  2. Install dependencies:

    cd notaion
npm install

  3. Set up the backend environment:

    • Update the connection string in appsettings.json to your database
    • Run the migrations to set up the database

  4. Start the project:

    npm run dev

Usage

  • To start chatting and create personal note, log in or register an account.
  • Send private messages to your contacts and manage friend requests in real time.