Creating a new project is time consuming. As developers, we spend more time bootstrapping projects instead of adding functionality. Sunrise is tackling this problem by helping developers easily get up and running without worrying about the build configuration.
- Requirements
- Getting Started
- Deployment
- Supported Browsers
- React
- Redux-Saga
- React-Router
- Re-Select
- React-Intl
- Jest
- Redux DevTools
- License
$ git clone https://github.com/bsheikh/sunrise.git <project-name>
$ cd <project-name>
$ yarn install
$ yarn run start:dev
Server is now running at http://localhost:4000.
[npm|yarn] run deploy:prod
creates a dist
directory with a production build of your app. Set HTTP server to serve index.html and the application will load.
For environments using Node, install serve
and let it handle the rest.
npm install -g serve
serve -s build
More Information: https://github.com/zeit/serve
- Navigate to the S3 service and click
Create Bucket
. Make up a clever name for your new bucket, then clickCreate
. - Click on the newly-created bucket. Within the
Properties
, open theStatic Website Hosting
tab, and selectEnable website hosting
. Fill inindex.html
for both the Index and Error Documents. By settingindex.html
as the Error Document, we can allow something like react-router to handle routes outside of the root. - Add the contents of your
dist
directory to this bucket. This can be done by clicking on the bucket and clickingUpload
. That’s it! You can find the URL to your application back under theStatic Website Hosting
tab, labeledEndpoint
. - Open the
Permissions
tab, then selectEdit bucket policy
. Edit bucket policy to allow read-only permissions for anonymous users.
Sunrise uses Jest as the test runner. Jest is a Node-based runner in which tests are ran in a node environment instead of a browser environment. This enables fast iteration speed and prevents flakiness.
Jest will look for test files with any of the following popular naming conventions:
- Files with
.js
suffix in__tests__
folders. - Files with
.test.js
suffix. - Files with
.spec.js
suffix.
It's recommend to put the test files (or __tests__
folders) next to the code they are testing so that relative imports appear shorter.
$ [npm|yarn] run test
$ [npm|yarn] run test -- --watch
$ [npm|yarn] run test -- --u
- Chrome
- Mozilla
- Safari
Copyright (c) 2017 Bill Sheikh
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.