This website was created to be a template for users to build their own simple e-commerce site. Users of the e-commerce site can create an account, log in, select items to add to their cart, and checkout out using stripe’s secure checkout process.
To preview the site as a guest user, these credentials may be used:
Email: test@test.com
Password: password
Stripe checkout is in Test Mode so there are no transaction costs for the user.
Use any info you like for the name and zip code section of checkout, however since this Stripe instance is in Test Mode you must use one of the test cards from the test card list as specified in the Stripe API.
Here is the test Visa card:
Credit Card: 4242 4242 4242 4242
CVC: any 3 digits
Expiration Date: any future date
Once the repo is forked:
run npm installto install all the dependencies needed.- Then run
npm run startto start up the server and client.
To start only the backend:
npm run server
For those who wish to use this template, all I ask is that you give me proper credit by linking back to my GitHub Repo.
A Mongo database is needed to store the product and user information. You will need create an env file and enter your own MongoDB URI.
In addition, if you plan to use Stripe for the checkout process, you will need to create an account and add your public key and private key to your env file.
Login authentication is handled by JSON Web Tokens. A secret is required for authentication to work. The secret can be any thing you like, just add it to the env file.
MONGODB_URI = YOUR_MONGO_URI
STRIPE_PRIVATE_KEY = YOUR_PRIVATE_KEY
STRIPE_PUBLIC_KEY = YOUR_PUBLIC_KEY
SESSION_SECRET = YOUR_OWN_SECRET
To add your own products you need to fill out the productSeeds and categorySeeds jsons in the seeders folder with your own products and categories.
For products to have an associated category, you need to enter its ID into the product json.
- Category IDs are generated in MongoDB after seeding the categories, so the category json should be run first.
- It may be helpful to have MongoDB Compass installed to see the category IDs and then add those to each product.
Once a json is filled out run npm run seed to populate your database.
MIT License
Copyright (c) 2023 Jose Dominguez
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.