Skip to content

Victor101106/ParvaNota

Repository files navigation

Notepad

ParvaNota

Small web application for basic text editing!

Content Table

Deployment

🔗 ParvaNota - Deployment

Screenshots

Screenshots

Requirements

  • NodeJS v20.x
  • npm v10.x
  • Docker >= v28.0.0

Getting Started

Follow the step-by-step instructions to set up and run the application:

Development Mode

  1. Clone the repository:

    git clone https://github.com/Victor101106/ParvaNota.git
  2. Install dependencies:

    npm install
  3. Run the application in development mode:

    npm run dev

Production Mode

  1. Clone the repository:

    git clone https://github.com/Victor101106/ParvaNota.git
  2. Install dependencies:

    npm install
  3. Build the application:

    npm run build
  4. Remove development dependencies:

    npm prune --production
  5. Run the application in production mode:

    npm run start

Production Mode with Docker

  1. Clone the repository:

    git clone https://github.com/Victor101106/ParvaNota.git
  2. Build and start the application container:

    docker compose up

Features

  • Should allow users to view the entire text field;
  • Should allow users to edit the entire text field;
  • Should allow users to delete the entire text field.

Word Count

  • Should allow users to view the word count of the text field under selection;
  • Should allow users to view the word count of the entire text field.

Interface Themes

  • Should allow users to change the text field theme to system default;
  • Should allow users to change the text field theme to dark mode;
  • Should allow users to change the text field theme to light mode.

Font Size

  • Should allow users to view the text field font size;
  • Should allow users to increase the text field font size;
  • Should allow users to decrease the text field font size.

Data Persistence

  • Should allow users to persist the text field font size;
  • Should allow users to persist the text field theme.

Clipboard

  • Should allow users to copy the entire text field;
  • Should allow users to paste the entire text field.

Repository

  • Should allow users to access the application's source code repository.

Conventional Commits

This project follows the Conventional Commits specification to maintain a clean and consistent commit history.

Message Structure

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Example:

feat(auth): add login functionality

License

Distributed under the GPL v3.0 license. See LICENSE for more information.

Contact

Victor Gabriel • Githubvictorgabriel101106+github@gmail.com