Listly

Listly is a ranked list maker application that allows users to create, compare, and rank lists with ease. This project is deployed on GitHub Pages and is built using modern web technologies.

Getting Started

To get started with Listly, follow these steps:

Prerequisites

• Node.js (version 22 or higher)

Installation

1. Clone the repository:

   git clone https://github.com/nishanbajracharya/listly.git

2. Navigate to the project directory:

   cd listly

3. Install the dependencies:

   npm install

Running the Application

To run the application locally, use the following command:

npm run dev

This will start the development server and you can access the application at http://localhost:3000.

Running Tests

To run the tests for the application, use the following command:

npm test

This will execute the test suite and display the results along with test coverage.

Building for Production

To build the application for production, use the following command:

npm run build

The production-ready files will be generated in the dist directory.

Deploying to GitHub Pages

To deploy the application to GitHub Pages, use the following command:

npm run deploy

This will build the application and push the dist directory to the gh-pages branch.

Contributing

If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.