Clone from our Github Page
Github PageAfter cloning from our Github Page, navigate to the kiwi folder and call npm install.
$ npm install
Next, navigate to the src folder and call npm install again.
$ npm install
Then, call npm start.
$ npm start
If you see the following lines of code in your terminal, the website is now up and running on localhost:3000
$ npm start
> react-social@1.0.0 start <Directory>\kiwi\src
> npm run build && node server.js
> react-social@1.0.0 build <Directory>\kiwi\src
> webpack
... (Many lines of webpack stuff)
Express server is up on port 3000
One error that some users encounter is that npm does not understand what webpack is
If this happens to you, all you need to do to fix it is to run npm install webpack
$ npm install webpack
One error that some users encounter is that npm does not install the babel plugin transform-object-rest-spread
If this happens to you, all you need to do to fix it is to run npm install babel-plugin-transform-object-rest-spread
$ npm install babel-plugin-transform-object-rest-spread
In order to enable reloading of the locally hosted webpage when you make changes to the code, call webpack-dev-server in the src folder inside of kiwi.
$ webpack-dev-server
If you see the following lines of code in your terminal, the website is now up and running on localhost:8080
$ webpack-dev-server
> development
> 10% building modules 1/1 modules 0 active ｢wds｣: Project is running at http://localhost:8080/
... (Many lines of webpack stuff)
｢wdm｣: Compiled successfully.
After cloning from our Github Page, navigate to the kiwi/src/app. There you will find many folders. The components, layouts, reducers, and styles folders affect the app's frontend. Most of your edits will be made in the files in the components folder. More information on the frontend can be found in the components page.
After cloning from our Github Page, navigate to the kiwi/src/app. There you will find many folders. The actions, api, constants, and firebase folders affect the app's backend. Most of your edits will be made in the files in the actions folder. Also the firebase config can be found in kiwi/config. More information on the frontend can be found in the components page.
After cloning from our Github Page, navigate to the docs folder inside of kiwi. There you will find a file named start.html, which you can edit to change the quick start page.
After cloning from our Github Page, you will see a file called .esdoc.json in the kiwi folder. This is the config file for ESDocs. Once installed and configured ESDocs automatically creates documentation based on the JSDoc tags that are in our source code.
After cloning from our Github Page, navigate to the docs folder inside of kiwi. There you will find a file named components.html, which you can edit to change the components page.
After cloning from our Github Page, navigate to the docs folder inside of kiwi. There you will find a file named faqs.html, which you can edit to change the FAQs page.
The updates page on our site just links to another site made by one of our members in order to have a record of our progress.
After cloning from our Github Page, navigate to the docs folder inside of kiwi. There you will find a file named license.html, which you can edit to change the About Us page.
After cloning from our Github Page, navigate to the __tests__ folder inside of kiwi. There you will find a multitude of test files. To add a new test suite simply create a new test file in this folder.
After cloning from our Github Page, navigate to the __tests__ folder inside of kiwi. There you will find a multitude of test files. To edit a test suite simply change the file for the component you are testing.
After cloning from our Github Page, navigate to the kiwi folder and call npm test. This runs the test script in the package.json file, which currently runs all tests which are in the __tests__ folder and do not have peter or regression in their name. This script is also run by Travis CI whenever you push a build to Github.
$ npm test