NOTE: Developed for Mac OSX and Ubuntu, Windows platforms will either not work or not perform as expected
To setup just run the following commands, ensure that a renti-backend instance is running somewhere within your machine (the front-end need data to access via endpoints from the backend!). Please ensure that you have Node.js and NPM installed. Node version should be at least 4.2.2 and NPM version should be at least 3.3.12.
npm install
For development launch the development server with the following command and view the app on localhost:3000.
npm run watch
For production setups use the following commands to build and run the web app:
npm run deploy
npm start
You can also change the backend that the web application or the mobile app is interfacing with. Simply change the following line within src/config/endpoints.js:
const baseURL = "<BASE URL OF THE BACKEND (for example: http://localhost:8080)>";
- Use an eslint plugin for your text editor! It's there to help you fix simple mistakes and follow the syntax guidelines setup by the project
- Use promises (no ajax! its not 2004 :p) for all requests to the server. This shouldn't be hard as all http methods (GET, POST, PUT, DELETE) are abstracted for you to use promises within util/request
- Use const keyword for immutable values and let keyword for mutable values, NO VARS ALLOWED WITHIN SOURCE CODE!
- Add all custom css within the styles folder
- Every react component you create has a parent named after its folder (for example: Signin.js === components/Signin)
- Only parent components are allowed to have state, meaning that you can only set states within parents. If you wish to add state to children, use props!
- Have fun and be creative, don't be sacred to mess around with things!