Skip to content

Latest commit

 

History

History
179 lines (128 loc) · 5.6 KB

README.md

File metadata and controls

179 lines (128 loc) · 5.6 KB

Logo

tukitak-E

An E-commerce project for CSE299

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Home Page

Our goal is to develop a functioning e-commerce website where customers can visit and browse necessary groceries of everyday life, add them to their cart, and checkout to complete their purchase as they would in a real-life grocery shop. Our vision is to make the website as feature-rich, user-friendly, and accessible as possible. The ultimate vision is definitely to add all the features an e-commerce website can have, whether it’s a feature related to UI/UX or a feature that is part of secure online payment.

Built With

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

Acknowledgements