· 5 years ago · Jan 29, 2021, 03:40 PM
1<br />
2<p align="center">
3 <h3 align="center">Proshop e-commerce fullstack Application</h3>
4
5 <p align="center">
6A fullstack e-commerce application built with Mongoodb,
7Express, React and Nodejs that has the main features of ecommerce platform: </p> <span>•</span>Product reviews and ratings.
8<br /><span>•</span>Full-featured shopping cart.
9<br /><span>•</span>Admin user management
10<br /><span>•</span>Paypal integration<br />
11</p>
12</p>
13
14<!-- TABLE OF CONTENTS -->
15<details open="open">
16 <summary>Table of Contents</summary>
17 <ul>
18 <ui>
19 <li><a href="#built-with">Built With</a>
20 </ui>
21 </li>
22 <li>
23 <a href="#getting-started">Getting Started</a>
24 <ul>
25 <li><a href="#prerequisites">Prerequisites</a></li>
26 <li><a href="#installation">Installation</a></li>
27 </ul>
28 </li>
29 <li><a href="#usage">Usage</a></li>
30 <li><a href="#roadmap">Roadmap</a></li>
31 <li><a href="#license">License</a></li>
32 <li><a href="#acknowledgements">Acknowledgements</a></li>
33 </ul>
34</details>
35
36<!-- ABOUT THE PROJECT -->
37
38## About The Project
39
40[![Product Name Screen Shot][product-screenshot]](https://example.com)
41
42There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
43
44Here's why:
45
46- Your time should be focused on creating something amazing. A project that solves a problem and helps others
47- You shouldn't be doing the same tasks over and over like creating a README from scratch
48- You should element DRY principles to the rest of your life :smile:
49
50Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!
51
52A list of commonly used resources that I find helpful are listed in the acknowledgements.
53
54### Built With
55
56<!-- Edit the links -->
57
58- [Express](https://getbootstrap.com)
59- [Node js](https://jquery.com)
60- [React](https://laravel.com)
61- [Mongoo Db](https://laravel.com)
62- [Redux](https://laravel.com)
63
64<!-- GETTING STARTED -->
65
66## Getting Started
67
68write how to install and files needed
69
70### Prerequisites
71
72This is an example of how to list things you need to use the software and how to install them.
73
74- npm
75 ```sh
76 npm install npm@latest -g
77 ```
78
79### Installation
80
811. Get a free API Key at [https://example.com](https://example.com)
822. Clone the repo
83 ```sh
84 git clone https://github.com/your_username_/Project-Name.git
85 ```
863. Install NPM packages
87 ```sh
88 npm install
89 ```
904. Enter your API in `config.js`
91 ```JS
92 const API_KEY = 'ENTER YOUR API';
93 ```
94
95<!-- USAGE EXAMPLES -->
96
97## Usage
98
99Use 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.
100
101_For more examples, please refer to the [Documentation](https://example.com)_
102
103<!-- LICENSE -->
104
105## License
106
107Distributed under the MIT License. See `LICENSE` for more information.
108
109<!-- CONTACT -->
110
111<!-- ACKNOWLEDGEMENTS -->
112
113## Acknowledgements
114
115- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
116- [Img Shields](https://shields.io)
117- [Choose an Open Source License](https://choosealicense.com)
118- [GitHub Pages](https://pages.github.com)
119- [Animate.css](https://daneden.github.io/animate.css)
120- [Loaders.css](https://connoratherton.com/loaders)
121- [Slick Carousel](https://kenwheeler.github.io/slick)
122- [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll)
123- [Sticky Kit](http://leafo.net/sticky-kit)
124- [JVectorMap](http://jvectormap.com)
125- [Font Awesome](https://fontawesome.com)
126
127<!-- MARKDOWN LINKS & IMAGES -->
128<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
129
130[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
131[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
132[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
133[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
134[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
135[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
136[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
137[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
138[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
139[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
140[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
141[linkedin-url]: https://linkedin.com/in/othneildrew
142[product-screenshot]: images/screenshot.png
143