xNote-Smart Note taking application

Description

xNote-fe is a front-end project built with React and TypeScript, utilizing Vite for development and TypeScript for type-checking.

Table of Contents

• API_Documentation
• Installation
• Usage
• Preview
• Features
• Scripts
• How To Contribute

APIDoc

• API Documentation

Installation

To install the project dependencies, run:

yarn

Usage

To start the development server, run:

yarn dev

For building the project, use:

yarn build

Lint the code with:

yarn lint

Preview the built project with:

yarn preview

Preview

Features

1. User Registration and Login:

   • Users can create accounts and log in securely.

2. Create and Edit Notes:

   • Users can create new text-based notes.
   • Notes can be edited and updated as needed.

3. Note Organization:

   • Users can organize their notes into notebooks or folders.
   • Notes can have tags for easy categorization.

4. Trash and Recovery:

   • Deleted notes are moved to the trash and can be recovered.

Scripts

• dev: Starts the development server using Vite.
• build: Builds the project using TypeScript and Vite.
• lint: Lints the TypeScript and TypeScript React files using ESLint.
• preview: Previews the built project.

---

Contribute

I welcome contributions to improve xNote and make it even better! To contribute to this project, please follow these steps:

1. Fork the repository by clicking the 'Fork' button on the top right of the page.
2. Clone your forked repository:

   git clone https://github.com/your-username/xNote-fe.git
   

3. Create a branch:

   git checkout -b feature/your-feature-name of issue/issue-number
   

4. Make necessary changes and commit those changes:

   git add .
   git commit -m "Add your feature or fix"
   

5. Push changes to your forked repository:

   git push origin feature/your-feature-name
   

6. Create a Pull Request (PR) from your forked repository to the main xNote repository. Describe the changes you made in detail mentioning the issue number if you worked on any issue listed on project.

Code Guidelines

• Follow the coding style and conventions already present in the project.
• Write clear commit messages and PR descriptions.

Issues and Feature Requests

If you encounter any issues or have suggestions for new features, please open an issue on the GitHub repository. Provide as much detail as possible to help us understand and address the problem or idea.

Thank you for contributing to xNote! 🚀 HapPy Coding ✨