https://github.com/elia/solidus_admin
https://github.com/elia/solidus_admin
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elia/solidus_admin
- Owner: elia
- License: bsd-3-clause
- Created: 2020-10-23T13:23:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T16:20:21.000Z (over 3 years ago)
- Last Synced: 2024-12-28T03:52:57.287Z (over 1 year ago)
- Language: HTML
- Size: 291 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Solidus Admin
[Explain what your extension does.]
## Installation
Add solidus_admin to your Gemfile:
```ruby
gem 'solidus_admin'
```
Bundle your dependencies and run the installation generator:
```shell
bin/rails generate solidus_admin:install
```
## Usage
[Explain how to use your extension once it's been installed.]
## Development
### Testing the extension
First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
app if it does not exist, then it will run specs. The dummy app can be regenerated by using
`bin/rake extension:test_app`.
```shell
bin/rake
```
To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
```shell
bundle exec rubocop
```
When testing your application's integration with this extension you may use its factories.
Simply add this require statement to your spec_helper:
```ruby
require 'solidus_admin/factories'
```
### Running the sandbox
To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
`sandbox/bin/rails`.
Here's an example:
```
$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop
```
### Updating the changelog
Before and after releases the changelog should be updated to reflect the up-to-date status of
the project:
```shell
bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"
```
### Releasing new versions
Your new extension version can be released using `gem-release` like this:
```shell
bundle exec gem bump -v 1.6.0
bin/rake changelog
git commit -a --amend
git push
bundle exec gem release
```
## License
Copyright (c) 2020 Nebulab SRLs, released under the New BSD License.