rin-yato / untitled

???? doesn't work on mobile 😞

Untitled

!!!Note This is a side project, that i work on with my limited time. There will be bugs. !!!

Hi there!

This is my first open source project, I'm hoping to be able to help beginner get a grasp of the basics of web development.

What is this project about?

This project is a simple web app that help manage a restaurant.

What is the purpose of this project?

The purpose of this project is to help beginner get a grasp of the basics of web development.

• UI/UX
• NextJS
• Typescript
• Data Handling
• Design Patterns
• Reusable Component

What are the technologies used in this project?

• Typescript
• NextJS - Meta Framework
• Vercel - Deployment
• TailwindCSS - CSS Framework
• Shadcn UI - UI Component
• Drizzle - ORM
• Neon Postgres - Database Deployment

How to run this project?

1. Clone this repository

2. Install dependencies

npm install
# or
yarn install
# recommended to use pnpm
pnpm install

3. Run the development server

npm run dev
# or
yarn dev
# or
pnpm dev

How to contribute to this project?

1. Fork this repository

2. Clone the repository

3. Create a new branch

4. Make changes

5. Commit and push

6. Create a pull request

Todos

• Add more features
• Notion API intergration
• Full test coverage for API
• Storybook
• Home page and Documentation
• Dockerize the project