Skip to content

Commit

Permalink
init alpine project planner
Browse files Browse the repository at this point in the history
  • Loading branch information
Zorkham committed Nov 5, 2024
0 parents commit a8d7488
Show file tree
Hide file tree
Showing 40 changed files with 11,515 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false
52 changes: 52 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"env": {
"browser": true,
"es2021": true,
"jest": true
},
"extends": [
"standard",
"plugin:@typescript-eslint/recommended",
"plugin:jest/recommended",
"plugin:prettier/recommended"
],
"parser": "@typescript-eslint/parser",
"plugins": ["jest", "@typescript-eslint"],
"rules": {
"@typescript-eslint/no-unused-vars": "warn",
"@typescript-eslint/no-explicit-any": "warn",
"prettier/prettier": "error",
"no-alert": "error",
"import/newline-after-import": [
"error",
{
"count": 1
}
],
"import/order": [
"error",
{
"groups": [["builtin", "external"], "internal"],
"newlines-between": "always",
"alphabetize": {
"order": "asc"
}
}
],
"max-len": [
"error",
{
"code": 120,
"ignoreComments": true
}
]
},
"overrides": [
{
"files": ["*.test.ts"],
"rules": {
"@typescript-eslint/no-empty-function": "off"
}
}
]
}
37 changes: 37 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Pre-deployment Checks

on:
pull_request:
branches:
- master
push:
branches:
- master

jobs:
checks:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '20'

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run linter
run: pnpm lint

- name: Run unit tests
run: pnpm test

- name: Run e2e tests
run: pnpm test:e2e
146 changes: 146 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
# /lib
/build
/dist

# misc
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Logs
logs
*.log

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# Commenting this out is preferred by some people, see
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
node_modules

# Users Environment Variables
.lock-wscript

# IDEs and editors (shamelessly copied from @angular/cli's .gitignore)
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### OSX ###
*.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Windows ###
# Windows thumbnail cache files
Thumbs.db
ehthumbs.db
ehthumbs_vista.db

# Folder config file
Desktop.ini
# config/production.*

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk

# Others
# lib/
data/
test/data
test/dev.sqlite3
.vscode/
.idea/
.next/
.history/
.nyc_output/
9 changes: 9 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"arrowParens": "always",
"bracketSpacing": true,
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "none",
"plugins": ["prettier-plugin-tailwindcss"]
}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Cédric Molla

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
97 changes: 97 additions & 0 deletions README copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Alpine Project Planner

Alpine Project Planner is a simple project management tool that allows users to add, edit, delete, search, and move tasks between different status columns. The application uses local storage to persist data and works on all devices.

**Demo: [alpine-project-planner.vercel.app](https://alpine-project-planner.vercel.app)**

[![Preview](./public/preview.png)](https://alpine-project-planner.vercel.app)

## Features

- **Add Task**: Users can add a new task by entering the task name and clicking the "Add Task" button.
- **Edit Task**: Users can edit a task by clicking the "Edit" button, updating the task name, and clicking the "Save" button.
- **Remove Task**: Users can delete a task by clicking the "Delete" button.
- **Search Task**: Users can search for a task by entering the task name in the search bar.
- **Move Task**: Users can change task status by dragging and dropping tasks.
- **Board View**: Users can view tasks in different columns based on their status (To Do, In Progress, In Review, Done).
- **List View**: Users can view tasks in different lists based on their status (To Do, In Progress, In Review, Done).
- **Local Storage**: The application uses local storage to persist data.
- **Responsive Design**: The application is responsive and works on all devices.

## Tech Stack

![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![Alpine.js](https://img.shields.io/badge/Alpine%20JS-8BC0D0?style=for-the-badge&logo=alpinedotjs&logoColor=black)
![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
![Prettier](https://img.shields.io/badge/prettier-%23F7B93E.svg?style=for-the-badge&logo=prettier&logoColor=black)
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
![Cypress](https://img.shields.io/badge/Cypress-17202C?style=for-the-badge&logo=cypress&logoColor=white)
![Cucumber](https://img.shields.io/badge/Cucumber-43B02A?style=for-the-badge&logo=cucumber&logoColor=white)
![PNPM](https://img.shields.io/badge/pnpm-%234a4a4a.svg?style=for-the-badge&logo=pnpm&logoColor=f69220)
![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)

- **Framework**: [Alpine.js](https://alpinejs.dev)
- **Styling**: [Tailwind CSS](https://tailwindcss.com)
- **Linting**: [ESLint](https://eslint.org)
- **Formatting**: [Prettier](https://prettier.io)
- **Testing**: [Jest](https://jestjs.io), [Cypress](https://www.cypress.io), [Cucumber](https://cucumber.io)
- **Package Manager**: [PNPM](https://pnpm.io)
- **Build Tool**: [Vite](https://vite.dev)
- **Deployment**: [Vercel](https://vercel.com)

## Getting Started

To get started with this project, follow these steps:

1. **Clone the repository**:

```sh
git clone https://github.com/zorkham/alpine-project-planner.git
```

2. **Install dependencies**:

```sh
pnpm install
```

3. **Run project locally**:

```sh
pnpm dev
```

4. **Open your browser**: Go to `http://localhost:3000` to see the app in action.

## Testing

This project uses Jest, Cypress, and Cucumber for testing. To run the tests, use the following commands:

- **Unit Tests**:

```sh
pnpm test
```

- **E2E Tests**:

```sh
pnpm test:e2e
```

- **All Tests**:

```sh
pnpm test:all
```

## Other Projects

- [Alpine Markt](https://github.com/Zorkham/alpine-markt)
- [Alpine Password Manager](https://github.com/Zorkham/alpine-password-manager)
- [Alpine Board Game Explorer](https://github.com/Zorkham/alpine-board-game-explorer)
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: ['@babel/preset-env']
}
Loading

0 comments on commit a8d7488

Please sign in to comment.