Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fherrerao/e-commerce-solidus


https://github.com/fherrerao/e-commerce-solidus

Last synced: 4 days ago
JSON representation

Awesome Lists containing this project

README 

        

![](https://img.shields.io/static/v1?label=BY&message=fherrerao&color=purple)



# e-commerce solidus

![Rails](https://img.shields.io/badge/rails-%23CC0000.svg?style=for-the-badge&logo=ruby-on-rails&logoColor=white)

![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)

![Bootstrap](https://img.shields.io/badge/bootstrap-%23563D7C.svg?style=for-the-badge&logo=bootstrap&logoColor=white)



[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./MIT.md)

![rails version](https://img.shields.io/badge/Rails-7-red)

![ruby version](https://img.shields.io/badge/Ruby-3.x-orange)



## Preview

![screenshot](./screenshoot.png)




## Table of Contents



- [Description](#description)

- [Built With](#built-with)

- [Live Demo](#live-demo)

- [Getting Started](#getting-started)

  - [Clone Repo](#clone-repo)

  - [Prerequisites](#prerequisites)

  - [Install Rails](#install-rails)

- [Setup](#setup)

  - [System Dependencies](#system-dependencies)

  - [Database Initialization](#database-initialization)

- [Usage](#usage)

  - [Start Server](#start-server)

- [How To Contribute?](#how-to-contribute)

- [Collaborators](#collaborators)

- [Show Your Support](#how-your-support)

- [Acknowledgments](#acknowledgments)

- [License](#license)




## Description

> It is a template for an e-commerce app built with `Solidus`, it shows a list of products ordered by categories, adding to cart, payment methods. Login created with `Devise`.




## Built With



- Major languages: Ruby, HTML, Bootstrap 5.

- Frameworks: Ruby on Rails.

- Tools & Methods: RSpec, PostgreSQL, Devise.




## Live Demo



Check this [Live Demo](https://budget-app.fly.dev/) of the page.



## Getting Started



We'll need to prepare your computer to handle Ruby on Rails, which might be a hassle, so take a deep breath and cope with me :)



If you have Rails 7 installed, you can skip to the [Setup](#setup) section



## Clone Repo



First clone this repo by running this command in your terminal:

~~~ bash

git clone https://github.com/fherrerao/e-commerce-solidus.git

# wait a couple seconds for it to download

# ...

# ...

# then move into the new directory

cd e-commerce-solidus

~~~






## Prerequisites



The following technologies must be installed before hand in your local machine:



 - Ruby (ruby --version). Should be 3.0.1 or newer.

 - Postgresql (postgres --version)

 - Node.js (node --version)

 - Yarn (yarn --version)  



The commands in parenthesis `()` can be used to verify if they are installed and their corresponding versions.



Refer to [Section 3](https://guides.rubyonrails.org/v5.1/getting_started.html#:~:text=3%20Creating%20a%20New%20Rails%20Project) from the official [Rails Guide](https://rubyonrails.org/) for more detailed instructions on how to install these technologies.



### Install Rails

Once that's done, we can install Rails. For that, run these commands in your terminal:

~~~ bash

gem install rails

# wait a few seconds for it to download

# ...

# ...

# verify that it was installed by running

rails --version

~~~




## Setup



We're getting there... trust me ;)



## System Dependencies



Execute this command to automatically install all the dependencies needed to view and work on this project:



~~~ bash

bundle install

~~~



The full list of dependencies can be found within the [Gemfile](Gemfile).



This also installs PostgreSQL, which you'll need for the next step.




## Database Initialization

To initialize the database we just created, now run:

~~~ bash

rails db:setup

~~~




## Usage

If you got to this point, congratulations! You now have spent 2 hours in order to toy with my app. I appreciate your effort :P



## Start Server

The following command should start a server

~~~ bash

rails server

~~~

Which you can visit by going to http://localhost:3000 in your browser.




## How To Contribute?



Always remember to commit your contributions on a different branch. You can create a new one by running `git checkout -b `.



Visit [linters folder](.github/workflows/linters.yml) to learn how to setup linters.



Then check linters locally before pushing by running:

~~~ bash

npx stylelint "**/*.{css,scss}"

# ...

# ...

rubocop --color -A

~~~



Finally, once your changes have no linter errors and all [tests](#testing-rails) are passing, try to merge your branch into  `development` by running:

~~~ bash

git checkout development

git merge 

~~~

Continue by solving any merge conflicts that may arise, test the functionality of the app once more, and you're changes are ready to be pushed with `git push origin `




# That's all folks!



## Collaborators






👤 **Fernando Herrera**



Platform | Badge |

 --- | --- |

 **GitHub**  | [@fherrerao](https://github.com/fherrerao)

 **Twitter** | [Fernando Herrera](https://www.linkedin.com/in/fherrerao/)

 **LinkedIn** | [Fernando Herrera](https://twitter.com/fherrera0206)





 

## Show your support



Give a ⭐️ if you like this project!




## Acknowledgments






## 📝 License



This project is [MIT](./LICENSE) licensed.