Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Remove source section
Damian Legawiec13c4c7cddc47
diff --git a/guides/src/content/developer/source/about.md b/guides/src/content/developer/source/about.mddeleted file mode 100644index e2d97be71e..0000000000--- a/guides/src/content/developer/source/about.md+++ /dev/null@@ -1,136 +0,0 @@-----title: About the Code-section: source-code------## What is Spree?--Spree is a full featured e-commerce platform written for the Ruby on Rails framework. It is designed to make programming commerce applications easier by making several assumptions about what most developers needs to get started. Spree is a production ready store that can be used "out of the box", but more importantly, it is also a developer tool that can be used as a solid foundation for a more sophisticated application than what is generally possible with traditional open source offerings.--Spree is 100% [open source](http://en.wikipedia.org/wiki/Open_source). It is licensed under the very permissive [New BSD License](https://github.com/spree/spree/blob/master/license.md). You are free to use the software as you see fit, at no charge. Perhaps more important than the cost, Spree is a true open source community. Spree has hundreds of contributors who have used and improved it while building their own e-commerce solutions.--## Motivation--The goal of the project is to build a complete open source commerce-solution for Ruby on Rails. At the start of this project, the Rails-commerce space was immature and lacking serious solutions for developers-with complex business needs. In the past, Rails has suffered from "small-project mentality." Most open source projects in Rails are maintained by-a single individual and tend to be limited in scope. Spree seeks to-create a large and healthy open source community that developers of-other languages have come to expect.--The founder of Spree was motivated to start the project after failing to-find an existing community in the Rails space dedicated to this vision.-In addition, he was motivated by unsuccessful efforts to use other open-source solutions in other programming languages, including (but not-limited to) the Magento and OSCommerce platforms. These solutions were-deemed to be unsatisfactory when challenged with even the simplest-practical cases of use.--### Opinionated Commerce--David Heinemeier Hansson (the creator of Rails) is well known for saying-that Rails is "opinionated software." Spree continues this fine-tradition of adopting a few strong (possibly controversial) opinions-which drive its development.--#### No Solution Will Satisfy Everyone--No solution can possibly solve everyone's needs perfectly. There are-simply too many ways in which people do business for us to tailor to-each individual need. Rather than come up short (like so many projects-before it did), Spree's approach is to simply accept this and not even-try. Instead Spree tries to focus on solving 90% of the bulk that most-commerce projects face. The remaining 10% will need to be addressed by-the end developer familiar with the client's exact business-requirements.--#### Online Commerce is not for "Noobs"--Rails developers are the target audience for this application - not-business owners. No serious company would ever try to run an online-store by just paying some fool on Craig's List to install OSCommerce for-them. Serious businesses have complicated needs that require paying one-or more software professionals to solve them. Spree seeks to be the-platform that developers use as the foundation for their project rather-than having to start from scratch or settle for less with other-software.--#### Developers Need Complete Control--Most business owners will not be satisfied with the generic templates-offered by other platforms. Why should they? They want their website to-look just like the other professional sites they see on the web. Most-businesses have very specific shipping and taxation rules as well. Spree-needs to be flexible enough to accommodate most situations. Sensible-defaults should be provided with an eye towards allowing further-customization.--#### Stay Focused--This is perhaps the most important principle behind the design-philosophy. We need to stay focused on core functionality (the 90% that-everybody needs.) For this reason it is not appropriate for Spree to-attempt to become a Content Management System (CMS). There are already-some pretty good Rails based CMS projects out there such as-[Radiant](http://radiantcms.org). CMS is definitely important but it is-a big enough task to warrant its own project. Spree will definitely be-looking at ways to integrate with existing CMS platforms, we just won't-be attempting to reinvent the CMS concept.--## Requirements--This guide is designed for beginners who want to get started with a-Spree application from scratch. It assumes a basic working knowledge of-Ruby on Rails. To get the most out of this guide, you need to have some-prerequisites installed:--- The [Ruby](http://www.ruby-lang.org/en/downloads) language-- The [RubyGems](https://rubygems.org/pages/download) packaging- system-- The [Ruby on Rails](http://rubyonrails.org/) gem-- A working installation of [SQLite](http://www.sqlite.org)- (preferred), [MySQL](http://www.mysql.com), or- [PostgreSQL](http://www.postgresql.org)--***-The SQLite database system is the default for development, since it-is relatively easy to set up compared to MySQL or PostgreSQL. For a-production system, we would recommend MySQL or PostgreSQL. Once you've decided,-You might consider using this in development as well, to reduce risk of-database specific bugs.-***--It is highly recommended that you **familiarize yourself with Ruby on-Rails before diving into Spree**. You will find it much easier to follow-what's going on with a Spree application if you understand basic Ruby-syntax.--There are many excellent online resources for learning Ruby on Rails,-including:--- [Rails Guides](http://guides.rubyonrails.org)-- [GoRails](https://gorails.com)-- [Schneems](https://www.schneems.com/)--There are also some good free resources on the internet for learning-Ruby, including:--- [Ruby Guides](http://www.rubyguides.com)-- [Programming Ruby](http://www.ruby-doc.org/docs/ProgrammingRuby/)-- [Refactoring Guru](http://refactoring.guru/design-patterns/ruby)-- [Ruby LibHunt](https://ruby.libhunt.com)--## Open Source License--Copyright © 2007-2019, Spree Commerce Inc. and other contributors.-All rights reserved.--Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:--- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.-- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.-- Neither the name of Spree Commerce Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.--This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner of contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.diff --git a/guides/src/content/developer/source/getting_help.md b/guides/src/content/developer/source/getting_help.mddeleted file mode 100644index e6525b6f81..0000000000--- a/guides/src/content/developer/source/getting_help.md+++ /dev/null@@ -1,28 +0,0 @@-----title: Getting Help-section: source-code------## Overview--There may be times when using Spree that the documentation doesn't answer all-the questions you may have. There are several other places on the internet where-you can go to ask Spree questions, and they are covered in this guide.--## Slack--Spree has a [Slack chat room ](http://slack.spreecommerce.org/) that can be used to discuss Spree in real-time.--## GitHub Issues--The [GitHub issues page for Spree](https://github.com/spree/spree/issues) shows-a list of currently open issues on Spree. If you think you have found a new-issue with Spree, please first read the [Filing an Issue](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md#filing-an-issue)-guidelines. If you provide the information we ask for there, we will be able to-help you with your issue much more effectively.--!!!-If you think you have discovered a security issue with Spree, please do not-report them publicly. Instead, email [our security-address](mailto:[email protected])-!!!diff --git a/guides/src/content/developer/source/index.md b/guides/src/content/developer/source/index.mddeleted file mode 100644index d9c3417fde..0000000000--- a/guides/src/content/developer/source/index.md+++ /dev/null@@ -1,17 +0,0 @@-----title: "Source Code"-section: source-code------Spree's functionality is split across seven different components:--* [**API**](https://api.spreecommerce.org): Provides a HTTP JSON API for several of Spree's components.-* [**Backend**](https://github.com/spree/spree/tree/master/backend): Provides the admin backend component for Spree;- things like product and order management.-* [**cmd**](https://github.com/spree/spree/tree/master/cmd): Provides the `spree` command, used for generating extensions.-* [**Core**](https://github.com/spree/spree/tree/master/core): Provides the minimum necessary functionality for Spree- to work.-* [**Frontend**](https://github.com/spree/spree/tree/master/frontend): Provides the front-facing functionality for- Spree; things like product viewing and checkout.-* [**Sample**](https://github.com/spree/spree/tree/master/sample): Provides the sample data for Spree, used for- setting up a new Spree store.diff --git a/guides/src/content/developer/source/navigating.md b/guides/src/content/developer/source/navigating.mddeleted file mode 100644index 76092a0a60..0000000000--- a/guides/src/content/developer/source/navigating.md+++ /dev/null@@ -1,289 +0,0 @@-----title: Navigating the Source-section: source-code------## Overview--This guide covers obtaining and running the source code. This is-primarily for developers who are interested in contributing code to the-Spree project or fixing the source code themselves. It is not necessary-to have a copy of the source code to run Spree. This guide covers the-following topics:--- How Spree uses Git and GitHub to manage source code-- The various gems that comprise the Spree source code-- Building the gem from the source--## Git--The Spree source code is currently maintained in a-[Git](http://git-scm.com/) repository. Git is a distributed version-control system (DVCS)--The authoritative git repository is hosted by-[GitHub](https://github.com/) and is located in the-[spree](https://github.com/spree/spree/tree/master) repository. You can-clone the git repository using the following command:--```bash-git clone git://github.com/spree/spree.git-```--***-If you are planning on contributing to Spree you should create a-fork through GitHub and push fixes to clearly labeled branches (see the-[Contributors Guide](https://github.com/spree/spree/blob/master/.github/CONTRIBUTING.md) for details.)-***--### Browsing the Repository and/or Downloading the Source Code--You can easily browse the repository through GitHub's excellent [visual-interface](https://github.com/spree/spree/tree/master). GitHub also-contains a link to download a tarball copy of the latest source code as-well as links to [previous-versions](https://github.com/spree/spree/tags).--### Git for Windows--There are some well developed Git clients for Windows now. If you are on-a Windows box you might want to check out the-[Git for Windows](https://git-for-windows.github.io/) project.--### Monitoring Changes in the Source--If you would like to keep up to date on changes to the source you can-subscribe to the GitHub-[RSS feed](https://github.com/spree/spree/subscription) and you-will be notified of all the commits.--## Bundler--Spree uses the very excellent [bundler](http://gembundler.com/) gem to-manage its dependencies. We are assuming you have basic familiarity with-bundler. A detailed explanation of bundler can be found on [Bundler's-site](http://gembundler.com/).--You can install the gem dependencies for Spree after cloning the-repository using this Bundler-provided command:--```bash-bundle install-```--This allows you to quickly and painlessly have the exact gem depedencies-you need to work with Bundler.--## Layout and Structure--### Collection of Gems--The Spree gem itself is very minimal and consists mostly of a collection-of gems. These gems are maintained together in a single GitHub-repository and new versions of the gems are shipped with each new Spree-release. The official documentation (which you are reading now) covers-functionality provided by each of these gems.--Within the Spree source, each of the gems is organized into-subdirectories as follows:--| Gem | Directory | Description |-| :--------------| :---------| :-------------------------|-| spree_api | api | Provides REST API access |-| spree_backend | backend | Backend functionality |-| spree_cmd | cmd | Command line utility for installing Spree and creating extensions |-| spree_core | core | Core functionality - all other gems depend on this gem |-| spree_frontend | frontend | Customer-facing functionality |-| spree_sample | sample | Sample data and images |--### Use of Rails Engines--Each of the gems in Spree makes use of Rails Engines. This functionality-was introduced in Rails 3.0 and allows Engines to behave in a manner-similar to fully-functional applications. Relying on this mechanism-provides several advantages:--#### An Intuitive Mechanism for Customization--Default Spree functionality is provided via the Rails engine gems.-Engines can provide several aspects traditionally associated with a-Rails application including (but not limited to):--- Models, views and controllers-- Routes-- Helpers-- Rake tasks-- Generators-- Locales--All of these elements can be overridden in the main Rails application.-Therefore, it is relatively simple to add Spree to your Rails-application and then customize it further by supplying your own elements-in that same application. A full discussion of Rails Engines is not-appropriate here. Please [consult the Rails Guides](http://edgeguides.rubyonrails.org/engines.html) for more information.--#### Simple Distribution and Installation as Gems--Using a Spree gem is as simple as adding it to your *Gemfile*:--```ruby-gem 'spree_core', '3.2.0'-```--Distribution of Spree (and its extensions) is also consistent with Rails-standards and modularity (see next.)--#### Consistency With a Rails Standard--Prior to version 0.30.0, Spree used a complex custom mechanism for-implementing "engine-like" functionality. While it was difficult to-strip this functionality out of Spree, the benefits are well worth it.-Spree now receives all of the massive testing and attention to detail-that comes for free when using the Rails core engine functionality,-rather than a custom solution.--#### Modularity--There are differing opinions on what belongs in the "core." People often express their opinion that Spree is either "getting too fat" or-"lacks basic features." By relying on these engines (and distributing-them as gems), developers are free to use only the parts of Spree that-they find useful. For instance, this would allow you to omit promotions-functionality or to replace the authentication mechanism.--For example, if you were to specify something like this in your-application's *Gemfile*:--```ruby-gem 'spree', '3.2.0'-```--It would require all the individual parts of Spree. However, if you only-wanted to require the "core" and "backend" parts of Spree, you would do-this:--```ruby-gem 'spree_core', '3.2.0'-gem 'spree_backend', '3.2.0'-```--## Building a Sandbox Application--When working with the Spree source you may find yourself wanting to see-how the code performs in the context of an actual application. This is-due to the fact that Spree is intended to be distributed as a gem and is-not designed to be run as a standalone application. Spree includes a-helpful Rake task for setting up such a test application.--To run this Rake task, go into the root of the Spree project and run-this command:--```bash-bundle exec rake sandbox-```--This will create a barebones rails application configured with the Spree-gem. It runs the migrations for you and sets up the sample data. The-resulting `sandbox` folder is already ignored by `.gitignore` and it is-deleted and rebuilt from scratch each time the Rake task runs.--## Building the Gem from the Source--The Spree gem can easily be built from the source. Run these two-commands in the root of the Spree project to do this:--```bash-bundle exec rake clean-bundle exec rake gem-```--Most likely you will want to build and install all of the related gems.-Fortunately, there is a simple Rake task for that.--```bash-bundle exec rake gem:install-```--You can also build just one specific gem.--```bash-cd core-bundle exec rake gem-```--## Tips for Working with the Source--### Using the "Edge" Code--If you are interested in simply using the latest edge code (as opposed-to contributing to it) then the simplest thing to do is add a *:github*-directive to your *Gemfile* and point it at the master branch.--```ruby-gem 'spree', github: 'spree/spree'-```--This will effectively use the latest code from the Git repository at the-time you run *bundle install*. This version of the code will be "frozen"-in your *Gemfile.lock* and will ensure that anyone else using your-project code is using the exact same version of the Spree code as you-are. You will need to update the bundle if you want to update to code-that is newer since the last time you updated.--```bash-bundle update-```--### Developing on the "Edge"--If you plan on using the edge code but also contributing back to Spree,-then you may be interested in the following approach. Create your Rails-app that will be using the Spree gem in a directory that has the same-parent as a locally cloned version of the Spree source. Then simply use-the following in your Gemfile.--```ruby-gem 'spree', path: '../spree'-```--***-See the excellent [Bundler documentation](http://gembundler.com) for more details.-***--### "-stable" branches--The Spree Git repository also contains stable branches for each minor Spree-version. For instance, there is a 3-2-stable branch which contains the latest-work for the 3.2.x branch of Spree. You may also decide to use this branch if you want the latest and greatest version of Spree:--```ruby-gem 'spree', github: 'spree/spree', branch: '3-2-stable'-```--Similarly, all main Spree extensions use this versioning scheme as well. For example, here's a line that would be used for `spree_auth_devise`:--```ruby-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '3-1-stable'-```--!!!-While the best efforts of the Spree team are made to keep stable branches-stable, there has been situations in the past where changes required for a-net-positive result over the entire community have affected some applications-or extensions. If a change to a stable branch does break your application or-an extension, please report those breakages on the appropriate GitHub page.-!!!--### Creating Extensions--Spree provides a convenient generator for helping you to get started-with extensions.--```bash-$ spree extension foo-```--***-You need to have the Spree gem installed in order to use the `spree` command.-***--Please see the [Creating Extensions](/developer/tutorials/extensions_tutorial.html) guide for more details.