https://github.com/maxkrv/chronos-fe
https://github.com/maxkrv/chronos-fe
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/maxkrv/chronos-fe
- Owner: maxkrv
- License: mit
- Created: 2025-03-04T17:09:57.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-03-28T16:48:13.000Z (over 1 year ago)
- Last Synced: 2025-04-06T19:55:39.069Z (about 1 year ago)
- Language: TypeScript
- Size: 1.01 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chronos
Chronos: Your Time, Perfected
Developed with the software and tools below.
## 🔗 Quick Links
> - [📋 Overview](#-overview)
> - [🚀 Tech Stack](#-tech-stack)
> - [💻 Getting Started](#-getting-started)
> - [⚙️ Installation](#️-installation)
> - [🕜 Running Chronos](#-chronos-fe)
> - [🤝 Contributing](#-contributing)
> - [📄 License](#-license)
---
## 📋 Overview
The Chronos Calendar is a modern, intuitive, and responsive web application that provides users with a seamless calendar management experience. Built with React and TypeScript, it offers a clean, accessible interface for managing events, schedules, and collaborations across personal and professional contexts.
---
## 🚀 Tech Stack
- **Core**: [TypeScript](https://www.typescriptlang.org/), [React](https://reactjs.org/), [React DOM](https://reactjs.org/docs/react-dom.html), [React Router DOM](https://reactrouter.com/), [Vite](https://vitejs.dev/)
- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/)
- **Styling**: [Tailwind CSS](https://tailwindcss.com/), [shadcn/ui](https://ui.shadcn.com/), [Radix UI](https://www.radix-ui.com/), [next-themes](https://github.com/pacocoursey/next-themes)
- **Icons**: [Lucide React](https://lucide.dev/), [React Icons](https://react-icons.github.io/react-icons/)
- **API Communication**: [ky](https://github.com/sindresorhus/ky)
- **Data Fetching**: [React Query](https://tanstack.com/query/latest)
- **Form Handling**: [React Hook Form](https://react-hook-form.com/), [Zod](https://zod.dev/)
- **Date Handling**: [Day.js](https://day.js.org/)
- **Development**: [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [PostCSS](https://postcss.org/), [Husky](https://typicode.github.io/husky/)
- **Containerization**: [Docker](https://www.docker.com/)
---
## 💻 Getting Started
### ⚙️ Installation
1. Clone the chronos-fe repository:
```sh
git clone https://github.com/maxkrv/chronos-fe
```
2. Change to the project directory:
```sh
cd chronos-fe
```
3. Install the dependencies:
```sh
npm install
```
### 🕜 Running chronos-fe
Use the following command to run chronos-fe:
```sh
npm run dev
```
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/maxkrv/chronos-fe/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/maxkrv/chronos-fe/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/maxkrv/chronos-fe/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/maxkrv/chronos-fe
```
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 licensed under the MIT License - see the [LICENSE](https://github.com/maxkrv/chronos-fe/blob/develop/LICENSE) file for details.
---