Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckydevboy/twinkle
A simple task mangement like Trello, under construction 🚧
https://github.com/luckydevboy/twinkle
drizzle-orm hono javascript nextjs postgres react shadcn-ui tailwindcss typescript
Last synced: 10 days ago
JSON representation
A simple task mangement like Trello, under construction 🚧
- Host: GitHub
- URL: https://github.com/luckydevboy/twinkle
- Owner: luckydevboy
- License: mit
- Created: 2024-09-01T09:51:08.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-09-21T09:49:01.000Z (14 days ago)
- Last Synced: 2024-09-21T11:03:59.176Z (14 days ago)
- Topics: drizzle-orm, hono, javascript, nextjs, postgres, react, shadcn-ui, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 459 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twinkle
**Twinkle** is a simple task management application inspired by Trello. It provides an intuitive interface for managing tasks with features like drag-and-drop, task assignment, and user authentication.
## Features
- **Drag and Drop**: Easily reorder tasks and columns using drag-and-drop functionality.
- **Task Assignment**: Assign tasks to different users for better organization.
- **Authentication**: Secure login and user management.
## Installation
To set up **Twinkle** locally, follow these steps:
1. **Clone the Repository**
```bash
git clone https://github.com/luckydevboy/twinkle
cd twinkle
```
2. **Install Dependencies**
**Ensure you have [pnpm](https://pnpm.io) and [bun](https://bun.sh/) installed.**
```bash
pnpm install
```
3. **Run the Application**
To start both frontend and server workspaces, use:
```bash
pnpm run dev
```
This will start the development server and the frontend.
## Usage
Once the application is running, you can access it at `http://localhost:3000` in your browser. Use the provided authentication system to log in and start managing your tasks.
## Contributing
We welcome contributions to **Twinkle**! To contribute:
1. **Fork the Repository**
2. **Create a Branch**: `git checkout -b feature/YourFeature`
3. **Make Your Changes**
4. **Commit Your Changes**: `git commit -am 'Add new feature'`
5. **Push to the Branch**: `git push origin feature/YourFeature`
6. **Create a Pull Request**
Please ensure that your code adheres to the project's coding standards and includes appropriate tests.
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
For any questions or support, please reach out to [[email protected]](mailto:[email protected]).