https://github.com/spree/spree_api_v1
Legacy Spree v1 API extracted from spree_api gem
https://github.com/spree/spree_api_v1
Last synced: about 2 months ago
JSON representation
Legacy Spree v1 API extracted from spree_api gem
- Host: GitHub
- URL: https://github.com/spree/spree_api_v1
- Owner: spree
- License: bsd-3-clause
- Created: 2022-10-17T15:28:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T23:01:40.000Z (almost 2 years ago)
- Last Synced: 2025-12-28T01:50:31.217Z (6 months ago)
- Language: Ruby
- Size: 125 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Spree Api V1
This repository contains the deprecated V1 API, that was extracted from spree_api gem in Spree 4.5.
## Installation
1. Add this extension to your Gemfile with this line:
```ruby
gem 'spree_api_v1'
```
2. Install the gem using Bundler
```ruby
bundle install
```
3. Copy & run migrations
```ruby
bundle exec rails g spree_api_v1:install
```
4. Restart your server
If your server was running, restart it so that it can find the assets properly.
## Contributing
In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
Here are some ways *you* can contribute:
* by using prerelease versions
* by reporting [bugs][2]
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving [issues][2]
* by reviewing patches
Starting point:
* Fork the repo
* Clone your repo
* (You will need to `brew install mysql postgres` if you don't already have them installed)
* Run `bundle`
* (You may need to `bundle update` if bundler gets stuck)
* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
* Make your changes
* Ensure specs pass by running `bundle exec rspec spec`
* Submit your pull request
License
----------------------
Spree is released under the [New BSD License][3].