lagnum22 / crunch-world

crunch-world

Table of Contents

1. About CrunchWorld
   • Built and Tested With
   • Prerequisites
2. Getting Started
   • Installation
3. Contributing
4. License
5. Contact

About CrunchWorld

Have you ever had a hankering for sweets beyond the normal assortment you find at convenience stores? Are you adventurous with taste or enjoy trying new things? Enter CrunchWorld! Our prototype e-commerce application was designed to feature dessert shopping from around the world. Think of it as an online confectionary that gives the consumer access to goods from around the world.

Built and Tested With:

• React
• Redux
• Material UI
• Node
• Express
• PostgreSQL
• Jest
• node.bcrypt.js
• Supertest

Prerequisites

• npm

  npm install npm@latest -g

Getting Started

To preview, simply fork our repo, clone it to your machine, run 'npm i' and then 'npm start'.

To run in developer mode, repeat same steps however run 'npm dev' to enable hot reloading ability using nodemon.

Installation

1. Clone the repo

   git clone https://github.com/PandaWhale/crunch-world.git

2. Install NPM packages

   npm install

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/NewFeature)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

License

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

Contact

Project Link: https://github.com/PandaWhale/crunch-world.git