diff --git a/.env b/.env index 186dbc3d..31ddcccf 100644 --- a/.env +++ b/.env @@ -1 +1 @@ -BASENAME=/rebwill.github.io/ +BASENAME= diff --git a/.gitignore b/.gitignore index 5d0e7b3c..d11635aa 100755 --- a/.gitignore +++ b/.gitignore @@ -59,4 +59,6 @@ public/ !.gitpod.yml !.htaccess !.eslintrc -!.env \ No newline at end of file +!.env +# Local Netlify folder +.netlify \ No newline at end of file diff --git a/README.md b/README.md index 4d0ca77a..c026660c 100755 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ +## rebwill.github.io + +## GIT PUSH INSTRUCTIONS + +git push origin dev + +## DEPLOY INSTRUCTIONS + +1. npm run build +2. npm run deploy + +--- + +## 4Geeks instructions + # WebApp boilerplate with React and Cloud 9 + # this is what react-hello-webapp deploys here [](https://gitpod.io#https://github.com/4GeeksAcademy/react-hello-webapp.git) ### Requirements: + - Make sure you are using node version 8 ##### Install the packages: + ``` $ npm install ``` @@ -14,19 +32,24 @@ $ npm install ## Start coding! Start the webpack server with live reload: + - `$ npm run start` for windows, mac, linux or Gitpod. - `$ npm run c9` for Cloud 9 Users. ### Styles + You can update the `styles/index.scss` or create new `.scss` files inside `styles/` and import them into your current scss or js files depending on your needs. ### Components + Add more files into your `./src/js/components` or styles folder as you need them and import them into your current files as needed. ### Views (Components) + Add more files into your `./src/js/views` and import them in `./src/js/layout.jsx`. ### Context + This boilerplate comes with a centralized general Context API. The file `./src/js/store/flux.js` has a base structure for the store, we encourage you to change it and adapt it to your needs. React Context [docs](https://reactjs.org/docs/context.html) @@ -37,7 +60,9 @@ The `Context.Provider` is already set, you can use the `Context.Consumer` to get This boilerplate is 100% compatible with the free github pages hosting. To publish your website you need to push your code to your github repository and run the following command after: + ```sh $ npm run deploy ``` + Note: You will need to [configure github pages for the branch gh-pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages) diff --git a/docs/src/js/layout.js b/docs/src/js/layout.js index 3449055d..815f2745 100755 --- a/docs/src/js/layout.js +++ b/docs/src/js/layout.js @@ -22,7 +22,7 @@ export class Layout extends React.Component { const basename = process.env.BASENAME || ""; return ( -