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

https://github.com/jhaji1997/synote-frontend

Manage your tasks and notes effortlessly with Synote's React frontend. Enjoy a responsive design, JWT authentication, and AI summarization. 🐙💻
https://github.com/jhaji1997/synote-frontend

ai-integration frontend lexical note-taking productivity react react-hooks react-router redux-toolkit rich-text-editor vite

Last synced: 3 months ago
JSON representation

Manage your tasks and notes effortlessly with Synote's React frontend. Enjoy a responsive design, JWT authentication, and AI summarization. 🐙💻

Awesome Lists containing this project

README

          

# Synote-Frontend: A React-Powered Note and Task Management App

![GitHub Repo Size](https://img.shields.io/github/repo-size/Jhaji1997/Synote-Frontend)
![GitHub Stars](https://img.shields.io/github/stars/Jhaji1997/Synote-Frontend)
![GitHub Forks](https://img.shields.io/github/forks/Jhaji1997/Synote-Frontend)
![GitHub Issues](https://img.shields.io/github/issues/Jhaji1997/Synote-Frontend)

## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Links](#links)

## Overview

Synote-Frontend is the client-side application for Synote, a comprehensive note and task management web app. Built with modern technologies like React, Redux Toolkit, and Tailwind CSS, Synote provides a smooth user experience. This app focuses on effective note-taking and task management, making it ideal for students, professionals, and anyone looking to enhance their productivity.

## Features

- **JWT-Based Authentication**: Secure user login and session management.
- **Rich-Text Editor**: Utilize Lexical for creating and formatting notes.
- **Task Management**: Organize tasks and subtasks for better productivity.
- **Protected Routes**: Ensure that users can only access their data.
- **AI-Powered Summarization**: Get concise summaries of notes with AI assistance.
- **Seamless Integration**: Works flawlessly with the Synote backend for managing user data and notes.

## Technologies Used

- **React**: For building user interfaces.
- **Redux Toolkit**: For state management.
- **Tailwind CSS**: For styling and layout.
- **Lexical**: For rich-text editing.
- **JWT**: For authentication.
- **Vite**: For fast development and build processes.

## Installation

To get started with Synote-Frontend, follow these steps:

1. **Clone the repository**:
```bash
git clone https://github.com/Jhaji1997/Synote-Frontend.git
```

2. **Navigate to the project directory**:
```bash
cd Synote-Frontend
```

3. **Install dependencies**:
```bash
npm install
```

4. **Run the application**:
```bash
npm run dev
```

The app will start on `http://localhost:3000`.

## Usage

After installation, you can access the application in your web browser. You will be prompted to log in or create a new account. Once logged in, you can start creating notes and managing tasks.

### Creating Notes

1. Click on the "New Note" button.
2. Use the rich-text editor to format your notes.
3. Save your notes to access them later.

### Managing Tasks

1. Navigate to the tasks section.
2. Create new tasks and subtasks.
3. Organize tasks by priority and deadlines.

### AI Summarization

1. Open a note.
2. Click on the "Summarize" button.
3. Receive a concise summary generated by AI.

## Contributing

We welcome contributions to Synote-Frontend! If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push to your forked repository.
5. Open a pull request.

Please ensure your code follows the project's coding standards and includes appropriate tests.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Links

For the latest releases, please visit [Releases](https://github.com/Jhaji1997/Synote-Frontend/releases). You can download the latest version and execute it as needed.

For further updates, check the [Releases](https://github.com/Jhaji1997/Synote-Frontend/releases) section in this repository.

Feel free to explore the project, contribute, and provide feedback. Happy note-taking!