https://github.com/donymvarkey/restly
Restly - A REST api client built with React, tailwindcss and shadcn ui. Simple but effective.
https://github.com/donymvarkey/restly
api-testing rest-api rest-api-client
Last synced: 4 months ago
JSON representation
Restly - A REST api client built with React, tailwindcss and shadcn ui. Simple but effective.
- Host: GitHub
- URL: https://github.com/donymvarkey/restly
- Owner: donymvarkey
- License: mit
- Created: 2024-12-10T09:11:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-29T06:30:17.000Z (over 1 year ago)
- Last Synced: 2025-05-21T19:17:00.088Z (about 1 year ago)
- Topics: api-testing, rest-api, rest-api-client
- Language: TypeScript
- Homepage:
- Size: 1.67 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Restly
Restly is a REST API client built with React, Tailwind CSS, and Shadcn UI. Simple but effective.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Build](#build)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#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:
```bash
git clone https://github.com/donymvarkey/restly.git
cd restly
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
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](https://github.com/donymvarkey/restly/blob/main/LICENSE) file for details.
## Acknowledgements
- [React](https://react.dev/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Vite](https://vite.dev/)
- [Shadcn UI](https://ui.shadcn.com/)