Cavendish
React Native + Expo project generator for Platanus
Installation
$ gem install cavendish
Or add to your Gemfile:
gem "cavendish"
bundle install
Usage
Cavendish uses Yarn under the hood, so make sure that you've installed in your system before running the generator.
Use the cavendish create
command to create a new project:
$ cavendish create <project-name>
This command will generate a full React Native + Expo project with:
- ESLint
- Testing with Jest and
@testing-library/react-native
- A base
@react-navigation
config for navigation and screens - A base
tailwind-rn
for managing styles - A base configuration of Expo Application Services (EAS)
- CI configuration for CircleCI
- An initialized Git repository
The generator uses the expo-cli
to generate a typescript blank managed workflow project. Bare workflow projects are not supported for now.
Testing
To run the specs you need to execute, in the root path of the gem, the following command:
bundle exec guard
You need to put all your tests in the /my_gem/spec/
directory.
Publishing
On master/main branch...
- Change
VERSION
inlib/cavendish/version.rb
. - Change
Unreleased
title to current version inCHANGELOG.md
. - Run
bundle install
. - Commit new release. For example:
Releasing v0.1.0
. - Create tag. For example:
git tag v0.1.0
. - Push tag. For example:
git push origin v0.1.0
.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Credits
Thank you contributors!
Cavendish is maintained by platanus.
License
Cavendish is © 2021 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.