Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukakerr/rails-ecommerce
An ecommerce site built using rails. Includes: users, products, carts, orders, categories, multiple images, custom pages, image banners and more
https://github.com/lukakerr/rails-ecommerce
ecommerce rails rails-ecommerce rails5
Last synced: 3 months ago
JSON representation
An ecommerce site built using rails. Includes: users, products, carts, orders, categories, multiple images, custom pages, image banners and more
- Host: GitHub
- URL: https://github.com/lukakerr/rails-ecommerce
- Owner: lukakerr
- Created: 2017-08-21T01:41:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-04T08:32:08.000Z (over 6 years ago)
- Last Synced: 2023-02-26T09:11:18.012Z (almost 2 years ago)
- Topics: ecommerce, rails, rails-ecommerce, rails5
- Language: Ruby
- Homepage:
- Size: 438 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ruby on Rails Ecommerce Site
This repository is a starter ecommerce web application written in ruby.
### Setup
To get started:
```bash
# Clone the repository
$ git clone https://github.com/lukakerr/rails-ecommerce.git
# Change directories
$ cd rails-ecommerce
# Start the PostgreSQL server (this command may vary depending on how you installed PostgreSQL)
$ brew services start postgresql
# Setup the database (details for login etc are in db/seeds.rb)
$ rake db:setup
# Start the rails server
$ rails s
# Navigate to localhost:3000
open http://localhost:3000
```
### Environment Variables
Inside `config/default.yml` is where all the username, passwords, environment variables etc are stored.
This includes things such as:
- PostgreSQL username and password
- Email details
- AWS S3 details
- Facebook key/secrets (for Facebook login)
- Google Analytics tracking code
You need to change at least the PostgreSQL values to your specific values before starting the application.
### Test
Make sure the database is running. Run `bundle exec rspec`.
### Features
- CRUD for:
- Users
- Products
- Image banners
- Orders
- Categories
- Pages
- Pictures
- Checkouts
- Facebook login
- Stripe
- AWS S3 image hosting
- Google Analytics
- Email via Gmail
- Cart
- Heroku support
### Stack
The ruby version used is `2.5.1`, and rails version `5.2.0`, although using relatively older/newer versions shouldn't break anything.
The application uses PostgreSQL as its database, so this must be installed.
Images are uploaded to Amazon AWS S3, so an account with Amazon is needed (only
in production).
Tests are driven by `rspec`, `factory_bot` and `faker`.
### To Do
- [ ] Add more tests
- [x] Integrate Stripe for payments
- [ ] Add email confirmation
- [ ] Add styling for products that are: on sale, featured or sold out
- [ ] Integrate 'buy now' feature
- [ ] Add pagination for products
- [ ] Improve overall styling
- [ ] Fix validations that don't appear when image size is too large