CheapStocks, an E-Commerce Webstore

This repository contains the source code for the Cheap Stocks e-commerce website. The platform aims to address the challenges customers face in accessing certain goods due to availability and affordability issues.

Table of Contents

• Project Description
• Features
• Technologies Used
• Setup/Installation
• Usage
• Project Structure
• Contributing
• License
• Support & Contact

Project Description

Cheap Stocks is an e-commerce platform dedicated to providing customers with easy access to a wide range of products at affordable prices. Our mission is to bridge the gap between product availability and affordability, ensuring that customers can find and purchase the goods they need without breaking the bank.

Features

• User-friendly product catalogue with descriptions and images
• Search and filtering options
• Shopping cart
• Customer reviews and ratings
• Responsive design for seamless mobile shopping

Technologies Used

• React.js for rendering
• CSS: for styling
• JSX
• json: for mock api

Setup & Installation

To get a local copy of the project up and running, follow these steps:

1. Clone the repository:

   git clone https://github.com/renegade620/cheapstocks.git
   

2. Navigate to the project directory:

   cd cheapstocks
   

3. Install the dependencies:

   npm install or npm i
   

4. Start the development server:

   npm start
   

The application should now be running on http://localhost:3000

Usage

To run the project in development mode:

npm run dev

To build the project for production:

npm run build

To start the production server:

npm start

To run json server:

npm run server

Project Structure

cheapstocks/
├── components/           # Reusable UI components
├── pages/                # React.js pages and API routes
├── public/               # Static assets (images, fonts, etc.)
├── styles/               # Global and component-specific styles
├── hooks/                # Custom React hooks
├── routes/               # routes
├── config/               # Configuration files
├── .gitignore            # Git ignore file
├── package.json          # NPM package configuration
├── README.md             # Project README file
└── package-lock.json     # NPM package lock file

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please create an issue or submit a pull request.

To contribute:

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature)
3. Make your changes and commit them (git commit -m 'Add some feature')
4. Push to the branch (git push origin feature/your-feature)
5. Open a pull request

License

This project is licensed under the Apache License. See the LICENSE file for more information.

Support & Contact

For any inquiries or questions, please contact the cheap stocks team at:

Email: franklinegift@gmail.com, maatifelix001@gmail.com, mwangiquincy77@gmail.com, jonathanmutinda16@gmail.com, watetumaureen108@gmail.com

Website: cheapstocks.vercel.app