Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mattlui/shopping-cart-boilerplate

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/mattlui/shopping-cart-boilerplate
Owner: MattLui
Created: 2024-02-09T04:26:36.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-02-12T05:10:45.000Z (9 months ago)
Last Synced: 2024-02-12T06:29:17.911Z (9 months ago)
Language: JavaScript
Size: 15.3 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Shopping Cart App

## Setup

1. Install [Node.js](https://nodejs.org/en/download/package-manager/) if you haven't already
2. Clone this repository
3. `cd` into the downloaded directory
4. `cd` into server and run `npm install` from the command line to install all dependencies

## DataBase Setup

1. Create mongoDB account - https://account.mongodb.com/account/register
2. Create a free AWS cluster
3. Go to `collections` (Browse Collections) and create a new database (shopping_cart) for example with two collections `products` and `cartitems`. Note: If you are going to work in pairs create two databases (for example team1_shopping and team2_shopping) and each database should have two collections `products` and `cartitems`.
4. Under Security tab, click Database Access, and on the right `add new database user`. After you enter username and password, click `add user` at the bottom right corner.
5. Under Security tab, click Network Access, and whitelist your IP address.
6. Once your cluster is created, under Clusters tab, click connect and then MongoDB for VSCode and copy the connection string which will look something like this `mongodb+srv://test123:@cluster0-zamyu.mongodb.net/`. Instead of `test123` there will be your username, and you will need to replace `` with your password and `test` with the database name. You will have to put the name of your database after the connection string with some flags `mongodb+srv://test123:@cluster0-zamyu.mongodb.net/?retryWrites=true&w=majority`. Change `` with the name of your database.
7. Finally, inside your project folder, `cd` into server, create new file `.env` and enter `DB=`. It will look similar to this `DB=mongodb+srv://test123:[email protected]/shopping_cart?retryWrites=true&w=majority`.

## Viewing Static Version of the App

While developing the app, you can take a look at the static pages that you'll eventually convert into a dynamic application. To do so, visit `http://localhost:5001/ui` in the browser. You are also encouraged to read and reuse the markup, classes and ids used in these static files in your components. They're located in the `/server/public/ui` folder.

## Developing the app

The starting point of the application is the `/client/src/index.js` file. That's where the root component of the application - `App` - is rendered to the DOM. You can add new components to the `/client/src/components` folder and new test files to the `/client/src/tests` folder.

For the initial application data, you can start with the following list of products:

```js
[
{
id: 1,
title: "Amazon Kindle E-reader",
quantity: 5,
price: 79.99,
},
{
id: 2,
title: "Apple 10.5-Inch iPad Pro",
quantity: 3,
price: 649.99,
},
{
id: 3,
title: "Yamaha Portable Keyboard",
quantity: 2,
price: 155.99,
},
{
id: 4,
title: "Tinker, Tailor, Soldier, Spy - A John le Carre Novel",
quantity: 12,
price: 13.74,
},
];
```

## DOCS

You can find documentation in the `docs` folder in `api.md` file.