Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 4.07 KB

README.md

File metadata and controls

92 lines (56 loc) · 4.07 KB
Raw

eCommerce-Application

Online store based on commercetools

This is a student frontend project for creating an online store based on commercetools. This project was created as part of the RS School JavaScript/Front-end 2023Q1 course. Commercetools is a flexible and powerful e-commerce platform that allows you to create modern online stores using the latest technologies.

Project Purposes

The main purposes of this project are to:

  • Collaborate as a team: This project provides an opportunity for team members to work together, share ideas, and learn from each other while building a real-world application.
  • Use commercetools: This project utilizes the commercetools platform, which is a flexible and powerful e-commerce solution that allows for the creation of modern online stores using the latest technologies.
  • Create a SPA (Single Page Application): The end result of this project is a SPA that provides a seamless shopping experience for users. The use of TypeScript to generate a SPA allows for fast and smooth transitions between different parts of the application, without the need for page reloads.

By achieving these purposes, the team will gain valuable experience in working together, using advanced technologies, and building a functional and user-friendly online store.

Features

  • Using commercetools to manage products, orders, and customers
  • Responsive design that looks good on all devices

Developers

Mentor

Built With:

  • HTML: for structuring the content of the web pages
  • CSS (with SASS preprocessor): for styling the web pages and making them visually appealing
  • TypeScript (TS): for generating the SPA and adding interactivity to the web pages, handling user interactions, and managing the application state
  • Jest: for testing JavaScript, designed to provide confidence in the correct operation of any JavaScript code

Used tools:

VS Code, Git, GitHub, Github Projects, Commercetools, Figma, Netlify, Webpack, ESLint, Husky, npm

Installation and launch for development

Getting started:

  1. Clone the repository: git clone https://github.com/nickoff/eCommerce-Application.git
  2. Go to the project directory: cd eCommerce-Application
  3. Switch to the development branch: git switch develop
  4. Install dependencies: npm install
  5. Start the project: npm run start
  6. From the develop branch, create and switch to a branch with the name of your work: git checkout -b feat/main-page
  7. Push changes with the commit “add main page”: git commit -m "feat: add main page"

Available Scripts

In the project directory, you can run:

  • npm run start

Runs the app in the development mode.
Open http://localhost:8080 to view it in the browser.

The page will reload if you make edits.

  • npm run build

Builds the app for production to the dist folder.
The build is minified and the filenames include the hashes.

  • npm run test

Launches all Jest's tests in the project.

  • npm run lint

Checks all the files in the src folder to meet the requirements of the ESlint rules.

  • npm run lint:fix

Checks all the files in the src folder to meet the requirements of the ESlint rules and tries to autofix them.

  • npm run format

Applies Prettier's code formatting to all the project's files.

Deploy

Online store

License

This project is distributed under the ISC license. See the LICENSE file for detailed information.