https://github.com/yinkakun/project-management-platform-demo

https://github.com/yinkakun/project-management-platform-demo

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/yinkakun/project-management-platform-demo
• Owner: yinkakun
• License: mit
• Created: 2023-02-16T17:29:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-17T15:20:27.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T07:11:39.572Z (3 months ago)
• Language: TypeScript
• Homepage: https://project-management-platform-demo.vercel.app
• Size: 99.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Hello World

## Features

- ⚡️ Next.js 12

- ⚛️ React 18

- ⛑ TypeScript

- 📏 ESLint — To find and fix problems in your code

- 💖 Prettier — Code Formatter for consistent style

- 🚫 lint-staged — Run ESLint and Prettier against staged Git files

- ⚙️ EditorConfig - Consistent coding styles across editors and IDEs

- 🗂 Path Mapping — Import components or images using the `@` prefix

### Development

To start the project locally, run:

```bash

yarn dev

```

Open `http://localhost:3000` with your browser to see the result.

### Requirements

- Node.js >= 12.22.0

- yarn

### Directory Structure

- [`public`](./public) — Static assets such as robots.txt, images, and favicon.


- [`src`](./src) — Application source code, including pages, components, styles.

### Scripts

- `yarn dev` — Starts the application in development mode at `http://localhost:3000`.

- `yarn build` — Creates an optimized production build of your application.

- `yarn start` — Starts the application in production mode.

- `yarn type-check` — Validate code using TypeScript compiler.

- `yarn lint` — Runs ESLint for all files in the `src` directory.

- `yarn format` — Runs Prettier for all files in the `src` directory.

### Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the `@` prefix.

```tsx

import { Button } from '@/components/Button';

// To import images or other files from the public folder

import avatar from '@/public/avatar.png';

```