Restly

Restly is a REST API client built with React, Tailwind CSS, and Shadcn UI. Simple but effective.

Table of Contents

• Features
• Installation
• Build
• Contributing
• License
• Acknowledgements

Features

• Built with React for a modern UI experience.
• Styled with Tailwind CSS for fast and responsive design.
• Utilizes Shadcn UI components.
• Simple and effective REST API client functionality.

Installation

To install and set up the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/donymvarkey/restly.git
   cd restly

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

Build

To build the app from source:

1. To create the dist, run npm run dist
2. To package the app, run npm run package
3. To build the app (target output will be generated for the host machine) npm run make

Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch with a descriptive name.(git checkout -b your-feature-name)
3. Make your changes and commit.
4. Push to the branch.
5. Create a new Pull Request.

License

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

Acknowledgements

• React
• Tailwind CSS
• Vite
• Shadcn UI