Whole documentation

Sutairu documentation

Sutairu web-app

Overview

Sutairu is a front-end app (SPA) for selling and managing products like clothes and decor. The application allows visitors to browse through the products catalogs. Users may register with an email and password which allows them to ctreate their own personal profile. Users with profiles can also edit or delete their own accounts at any time + personalised them with uploading their own profile picture.

The SPA"Sutairu" is an app for shopping japanesse stok, like various clothes and decor.

• Technologies: JavaScript, HTML,CSS,Node.js,Express.js,Redux,MongoDB,Firebase,Nodemailer,Jest and others

Pages and permissions

All users 🔒

• 📌 Home /home

  

• 📌 Product page /{main category/sub category}

  

• 📌 Product details /products/:id

  

• 📌 Login /login

  

• 📌 Register /signup

  

• 📌 Contact us /contact-us

  

• 📌 About us /about-us

  

  Authentication users 🔏

• 📌 Home /home

• 📌 Product page /{main category/sub category}

• 📌 Product details /products/:id

• 📌 About us /about-us

• 📌 Contact us /contact-us

• 📌 Profile: /account

• 

• 📌 Update Profile /update-profile

• 

• 📌 Cart component

  

  Admin users 🔏

• 📌 Admin page /dashboard/admin

• 

• 📌 Home /home

• 📌 Product page /{main category/sub category}

• 📌 Product details /products/:id

• 📌 About us /about-us

• 📌 Contact us /contact-us

• 📌 Profile: /account

• 📌 Profile: /account

• 📌 Cart component

• 📌 Update Profile /update-profile

How to start the the backend server?

• 📌 First you must install all dependencies included in the package.json file by typing npm install in a terminal. Then you must start the server by typing npm run dev in the terminal in the root.

After that the server will run on http:/localhost:3000 URL.

How to start the the frontend?

• 📌 Firstly you must install all dependencies included in the package.json file my-app by firstly typing cd .\my-app\ and tnen npm install in the same folder. Then you must start the server by typing npm start in the terminal in the my-app. The frontend will be running on http:/localhost:3001 URL.

• 📌 For the link between the server and the frontend, you need to add the link for the frontend in the cors integration in the backend. Next you should add for every fetch in the code the developer link for the backend for the fetching to work.

• 📌 Backend cors integration

  

• 📌 Frontend fetch

  

Executing the Tests

Before running the test suite, make sure a backend server is operational, and the application can be found at the root of its network address. To start the included dev-server, open a terminal in the folder containing package.json and execute: npm run dev

This is a one-time operation unless you terminate the server at any point. It can be restarted with the same command as above. To execute the test, open a new terminal (do not close the terminal, running the web server instance) in the folder containing package.json and execute: npm run test

Test result will be desplayed in the terminal, along detailed information about encountered problems. You can perform this operation as many times as it is necessary by re-running the above command.