Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.28 KB

README.md

File metadata and controls

65 lines (48 loc) · 2.28 KB
Raw

Restaurant App

This project is created solely for learning purposes. It is designed to help developers understand and practice various concepts and technologies, including but not limited to React, Sass, TypeScript, and modern web development practices.

Purpose

The primary goal of this project is educational. It provides a sandbox environment where developers can experiment, learn, and improve their skills in a practical manner.

Features and methods

  1. Atomic Design
  2. Sass
  3. TypeScript
  4. Next.js
  5. Conventional Commits and Commitizen
  6. Storybook
  7. BEM Methodology
  8. CSS Modules
  9. Jest
  10. Cypress
  11. User-Centric Performance Metrics

Our UIX is here

Setup

To get started with this project, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/bruno-keiko/Restaurant-app.git
  2. Navigate to the project directory: 
    cd restaurant-app
  3. Install dependencies: 
    npm install
  4. Start the storybook: 
    npm run storybook
  5. Start the development server: 
    npm run dev

Usage

This project is intended to be used as a practice ground for learning and experimenting with web development technologies. Feel free to modify, extend, and play around with the codebase to enhance your understanding.

Contribution

Contributions are welcome! Please refer to the CONTRIBUTING.md file for guidelines on how to contribute to this project.

License

This project is licensed under the MIT License. See the LICENSE file for more details.


This update directs potential contributors to the `CONTRIBUTING.md` file for more detailed guidelines on contributing to your project.