Amped React Boilerplate is a project that has everything setup to work with the Amped Framework. This functions as the starting point for you to build your site on top of so this should be cloned and the remote url should be changed to your repo.
The idea behind the Amped project is to get you up and started with the basics you need with for any project and allowing you to focus on the business logic of your app.
A demo can be found at: http://demo.rebelpixel.ca/
Username: [email protected]
Password: 123
If you are on mac or linux you can just run ./install.sh
If you are on windows you can run
npm install
cd lib
git clone https://github.com/rebelpixeldev/amped-react-core
The lib directory is where you can install whichever Amped react project you need. Currently only the core react project is available. This will be downloaded for you when you run the install script and placed in the lib directory. You can find that project here
Running npm start will startup the project by compiling the source and starting a webpack dev server with hot reloading to serve your files on http://localhost:3000. When using nginx on your webserver, you can serve the files directly with nginx.
bin- This is only for your local development. The files in here are the logic the runs webpack functions either to compile your code or startup the dev serverconfig- All of the config files for the projectlib- This is a temporary directory for the amped react plugins that you will use in your project during development of the framework. Once the boilerplate and framework get a little more developed, these plugins will be included through npmpublic- Not many files in here but will this should be served up as static files on your web serverserver- Files that will run the the local dev serverdist- Not in the repo but is added when webpack compiles all of your files static files on your server should be served from here.src- Here's where the fun starts! This is where you will code your project. The files that are in there to start are to show you one way of doing things but the skys the limit.components- Used as a grouping of similar components, you can think of all the directories in here as 'modules'. Within each module, there can be a components, containers, styles, routes and anything else that is specific to that module.containers- Currently just the main app componentstore- The logic to setup your redux store. By default it will setup all of the routes in this boilerplate project and pull the routes fromlib/amped-react-core. All of your custom routes and any other plugins you add into lib, you will need to add the routes to here manually.main.js- This is the starting point for the app. It will setup the store and mount the initial component.routes.js- The containers, components, styles and anything else that will be on specific pages of your app.theme.js- The react version of the Amped Framework uses material UI to style the basics of all components. theme.js is were you can customize the primary colors of the site.
If everything is setup with your frontend project, you'll need the api up and running before anything will display in your browser without javascript errors. See the Amped api boilerplate project for more info