End-to-end testing is powered in part by BrowserStack, thanks to their support of Open Source projects.
MIT
Though it is not a requirement in order to install & run the code in this frontend app
repo, there is a backend api
at https://github.com/StoryShop/api that should be installed & running first if one wants to spin up the complete application.
First you need to update your /etc/hosts
file to include dev.storyshopapp.com
, like so:
##
# Host Database
#
# localhost is used to configure the loopback interface
# when the system is booting. Do not change this entry.
##
127.0.0.1 localhost dev.storyshopapp.com
255.255.255.255 broadcasthost
::1 localhost
Then run the following commands to install your dependencies and run the app in dev mode.
$ npm install
$ npm run dev
Then access the site on dev.storyshopapp.com:8888
Please see CONTRIBUTING.md.
One key point is that we would prefer all Pull Requests be submitted from branches on our main StoryShop
repos, rather than from engineers' forks, so that we are in a better position to expedite review & approval by making small corrections if need be. If you are not already a member of the org, please let us know if you would like to be granted write access for the purpose of submitting a PR.
Check out our getting started guide to learn more about the file structure, routing, and component architecture.