Loky Store

A shopping website you can sell your products

View Demo · Report Bug

About The Project

Loky Store is my portfolio project, showcasing my web development skills. It's a straightforward e-commerce website concept, highlighting some key features:

• Horizontal Product List: Browse products conveniently with a horizontal scrolling product list.
• Minimap of Product List: A minimap provides an overview of available products for easy navigation.
• Smooth Scrolling: Scroll vertically and horizontally for improved navigation.
• Product Cart Details: View product details, dimensions, sizes, and quantities in the cart.
• User Basket: Keep track of added products in the user's basket.
• User Authentication: Sign in, sign up, and contact features for a personalized experience.
• Admin Panel: Admins can manage users, products, contacts, and orders.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Frontend:

• Vue.js: A progressive JavaScript framework for building interactive web interfaces.
• Vuex: A state management pattern and library for Vue.js applications, helping manage and synchronize data across components.
• Fuse.js: A lightweight fuzzy-search library for implementing search functionality.
• Axios: A promise-based HTTP client for making API requests.

Backend:

• Node.js: A JavaScript runtime that powers the server-side logic of the application.
• Express: A minimal and flexible Node.js web application framework used to build the API.
• Express Session: Middleware for managing user sessions.
• Passport.js: Authentication middleware for Node.js applications.
• Mongoose: An Object Data Modeling (ODM) library for MongoDB, simplifying database interactions.

DevOps:

• Docker: Containerization technology used to package the application and its dependencies.
• Docker Compose: Simplifies multi-container Docker application management.
• Google Cloud: The project is deployed to Google Cloud, leveraging its scalable and reliable cloud infrastructure.

(back to top)

Getting Started

To get this project up and running locally, follow these simple steps:

1. Clone the Repository:

   git clone https://github.com/softwareVirus/lokystore.git
   

Running the stack

$ docker-compose up

Accessing the stack from a browser

The starter stack works with a load balancer that binds to ports 80 and 443. It currently serves the domain http://stack.localhost. In order to reach the frontend through the stack, you need to edit your hosts file (usually under /etc/hosts in UNIX environments and C:\Windows\System32\Drivers\etc\hosts in Windows) and add the following line:

127.0.0.1 stack.localhost

Now if you visit http://stack.localhost, you will be greeted with the frontend starter project.

Changing the local domain

If you wish to use a domain name other than http://stack.localhost, simply set the environment variable DOMAIN to any domain you want.

$ DOMAIN=another-domain.localhost docker-compose up

You then also need to update your hosts file accordingly.

Debugging

You can debug the backend while it's running in VSCode. Instead of running docker-compose up, run the following command:

$ docker-compose -f docker-compose.yml -f docker-compose.debug.yml up

This starts the backend service in the debug mode, so you can use the built-in debug task Attach to backend to debug your backend service.

Running tests

Running backend tests

$ cd backend
$ npm i
$ npm test

Running frontend tests

$ cd frontend
$ npm i
$ npm test:unit
$ npm test:e2e

Linting

Run npm install on the root folder and it will set up a pre-commit hook to lint the staged files. You will also have two lint commands, npm run lint and npm run lint-staged that you can run on the root folder.

These commands run the individual lint and lint-staged scripts in both the frontend and the backend folders, and they will respect individual configurations of these folders.

Contributing

We welcome contributions from the open-source community to make Loky Store even better. If you're interested in contributing, please refer to our Contribution Guidelines.

License

MIT License

Copyright (c) 2020 Coyotiv®

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.