Skip to content

Home

Jump to bottom
Yehor edited this page Nov 24, 2023 · 16 revisions

Project description

Welcome to the Gold Fish wiki!

Gold Fish is a MERN stack application with TypeScript

The aim of this project is to design and implement an online store that will specialize in the sale of digital games, while also offering elements of a discussion forum for the gaming community. Such a store will allow players to conveniently purchase games and at the same time participate in interactive discussions, reviews, exchange of experiences and sharing observations about individual titles.

The website is designed to allow you to search, buy games, view ratings, add ratings and reviews, create an account, view your order history, write a blog, create events, admins can add products, edit them, edit events, blogs and view statistics on orders on the website

The site will also have an adaptive version for all devices, which will help increase the comfort of use for users and expand the audience

Installation

A quick introduction how to run a project and what commands you can use

How to install

  1. Clone the repo 
    git clone https://github.com/Freekson/React-Employees.git
    Go to backend folder 
    cd backend
  2. Install NPM packages 
    npm install
  3. Go to frontend folder 
    cd ../frontend
  4. Install NPM packages 
    npm install
  5. Run backend and frontend command 
    npm run dev

Other commands

Backend Commands
Frontend Commands

Project structure

backend folder, this is where the Node.js backend with Express.js is located, including routes, MongoDB database and server logic. Check Backend Structure

frontend folder, inside this folder is the front-end part of React, including components, routing, styles and everything related to the client side of the application. Frontend Structure

README.md, contains a description of project or repository, using Markdown syntax

Functionality that should be on the site

  • Mobile version
  • Error handling, displaying messages on the page
  • Tests for different cases
  • Localstorage for storage of user data
  • 15+ different pages
  • Fetching games, categories, articles, events from backend
  • Filtering by category, price, publisher, date, reviews, discounts and by keywords
  • Register and login with JWT
  • Add products to cart, edit quantity in cart
  • Order placement
  • Order payment by PayPal
  • Promo codes for active users
  • User page with loyalty program
  • Users can see their orders' status in profile
  • Users can edit their data
  • Users can register for event
  • Users can add products for their wishlist
  • Authors can write blogs and create events
  • Admins can check dashboard
  • Admins can see all users' data, and edit it
  • Admins can delete blogs and events
  • Admins can confirm order delivery for users
  • Admins can add new products to DB
  • Admins can give users author status
  • Main admin can give users admin status, and delete it

Clone this wiki locally