Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkloz/usof-frontend
Post sharing app. React SPA. https://usof.mkloz.online/
https://github.com/mkloz/usof-frontend
axios dayjs lucide-react react-query reactjs shadcn-ui tailwindcss vite zod zustand
Last synced: 19 days ago
JSON representation
Post sharing app. React SPA. https://usof.mkloz.online/
- Host: GitHub
- URL: https://github.com/mkloz/usof-frontend
- Owner: mkloz
- License: mit
- Created: 2024-11-04T20:53:10.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T23:31:20.000Z (about 1 month ago)
- Last Synced: 2024-11-28T00:23:04.680Z (about 1 month ago)
- Topics: axios, dayjs, lucide-react, react-query, reactjs, shadcn-ui, tailwindcss, vite, zod, zustand
- Language: TypeScript
- Homepage: https://usof.mkloz.online/
- Size: 152 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
It is a modern Reddit-like frontend built with cutting-edge technologies to provide a seamless experience. Explore and enjoy a user-friendly interface designed with React and Tailwind CSS.
Developed with the software and tools below.
## 🔗 Quick Links
> - [📍 Overview](#-overview)
> - [🚀 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🤖 Running usof-frontend](#-running-usof-frontend)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
> - [👏 Acknowledgments](#-acknowledgments)
---
## 📍 Overview
USOF is a state-of-the-art frontend application inspired by Reddit. Utilizing React and Tailwind CSS, it offers a fast, responsive, and intuitive user interface. Whether you're browsing, posting, or engaging with content, USOF provides a smooth and enjoyable experience. Discover its features and see how it excels as a modern frontend solution.
## 🚀 Getting Started
### ⚙️ Installation
1. Clone the usof-frontend repository:
```sh
git clone https://github.com/mkloz/usof-frontend
```
2. Change to the project directory:
```sh
cd usof-frontend
```
3. Install the dependencies:
```sh
npm install
```
### 🤖 Running usof-frontend
Use the following command to run usof-frontend:
```sh
npm run dev
```
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/mkloz/usof-frontend/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/mkloz/usof-frontend/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/mkloz/usof-frontend/issues)**: Submit bugs found or log feature requests for Online-store-frontend.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone https://github.com/mkloz/usof-frontend
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [MIT](/LICENCE) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/mit) file.
---
