sashadudkina5 / BurgerApp_React

Study project: React, Redux, TypeScript, WebSocket

Home Page:https://sashadudkina5.github.io/BurgerApp_React/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

React Project: BurgerApp

This project is a dynamic web application built with Create React App. It's a burger builder application where users can customize their burger with various ingredients, place orders, and review past orders.

Deployed Site

The application is deployed and can be accessed at BurgerApp Live Site.

Technologies Used

  • ReactJS
  • Redux
  • React Router
  • TypeScript
  • Jest
  • Cypress
  • WebSocket

Future Plans

In addition to the existing features, here are some future plans for enhancing the BurgerApp:

  • Responsive Design for Mobile Screens

  • Enhanced Form Input Styles and Functionalities

Documentation

The project is documented with JSDoc. This includes:

  • Documentation for all React components, providing insights into the props and states used.
  • Documentation for all thunk functions to understand the asynchronous operations and redux state management.
  • Descriptions for supplementary functions.

This effort aims to make the codebase more accessible and to facilitate easier updates and feature additions.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

npm run eject

Note: This is a one-way operation. Once you eject, you can't go back!

npm run deploy

Deploys the application to GitHub Pages. Requires the gh-pages package and a predeploy script to build the application before deployment.

How to Download and Run Locally

  1. Clone the repository:

git clone https://github.com/sashadudkina5/react-project-BurgerApp.git

  1. Install dependencies:

cd react-project-BurgerApp npm install

  1. Run the application:

npm start

Learn More

For more information on how to use Create React App, you can check out the Create React App documentation.

To learn more about React, check out the React documentation.

About

Study project: React, Redux, TypeScript, WebSocket

https://sashadudkina5.github.io/BurgerApp_React/


Languages

Language:TypeScript 76.0%Language:JavaScript 19.0%Language:CSS 4.2%Language:HTML 0.8%