Commit 4935c163f99330391492205523cda6e6e5547d4e
1 parent
667ddb29bc
Exists in
master
README.md edited online with Bitbucket
Showing
1 changed file
with
6 additions
and
0 deletions
Show diff stats
README.md
| 1 | Tech stack is Meteor in backend and react in front-end. | 1 | Tech stack is Meteor in backend and react in front-end. |
| 2 | We are using react-router for all the routing purpose. | 2 | We are using react-router for all the routing purpose. |
| 3 | 3 | ||
| 4 | ##File Structure | 4 | ##File Structure |
| 5 | ``` | 5 | ``` |
| 6 | 6 | ||
| 7 | |--ydapp/ | 7 | |--ydapp/ |
| 8 | | |--client | 8 | | |--client |
| 9 | | | |--styles/ //-- All the styles | 9 | | | |--styles/ //-- All the styles |
| 10 | | | | |--components/ //-- Depreciated LESS styles | 10 | | | | |--components/ //-- Depreciated LESS styles |
| 11 | | | | |--layouts/ //-- SCSS styles | 11 | | | | |--layouts/ //-- SCSS styles |
| 12 | | | | |--lib/ //-- Styling variables | 12 | | | | |--lib/ //-- Styling variables |
| 13 | | | | |--mixins/ //-- All the mixins | 13 | | | | |--mixins/ //-- All the mixins |
| 14 | | | | |--vendor/ //-- Fonts and icons | 14 | | | | |--vendor/ //-- Fonts and icons |
| 15 | | | | |--views/ //-- SCSS styles | 15 | | | | |--views/ //-- SCSS styles |
| 16 | | | |--main.html //-- Main | 16 | | | |--main.html //-- Main |
| 17 | | | |--main.js //-- Import main | 17 | | | |--main.js //-- Import main |
| 18 | | |--imports/ | 18 | | |--imports/ |
| 19 | | | |--client/ //-- Application logic | 19 | | | |--client/ //-- Application logic |
| 20 | | | | |--app/ //-- App routes and some common components | 20 | | | | |--app/ //-- App routes and some common components |
| 21 | | | | |--views/ //-- All the view part | 21 | | | | |--views/ //-- All the view part |
| 22 | | | | | |--app/ | 22 | | | | | |--app/ |
| 23 | | | | | |--etc/ //-- some sample files | 23 | | | | | |--etc/ //-- some sample files |
| 24 | | | | | |--invalidOrg/ //--View when someone enter a non registered subdomain | 24 | | | | | |--invalidOrg/ //--View when someone enter a non registered subdomain |
| 25 | | | | | |--nonOrg/ //--View for main site | 25 | | | | | |--nonOrg/ //--View for main site |
| 26 | | | | | |--Org/ //--Organisation specific vies | 26 | | | | | |--Org/ //--Organisation specific vies |
| 27 | | | |--collections/ //-- Application collections | 27 | | | |--collections/ //-- Application collections |
| 28 | | | |--server/ //-- Server side processing and integrations | 28 | | | |--server/ //-- Server side processing and integrations |
| 29 | | |--private/ | 29 | | |--private/ |
| 30 | | | |--fixtures/ //-- Application fixtures | 30 | | | |--fixtures/ //-- Application fixtures |
| 31 | | |--public/ | 31 | | |--public/ |
| 32 | | | |--files/ //-- Raw fonts and SVG assets | 32 | | | |--files/ //-- Raw fonts and SVG assets |
| 33 | | |--server/ //-- Main JS | 33 | | |--server/ //-- Main JS |
| 34 | | |--tests/ //-- For running tests | 34 | | |--tests/ //-- For running tests |
| 35 | | |--package.json //-- Node.js dependencies | 35 | | |--package.json //-- Node.js dependencies |
| 36 | | | 36 | | |
| 37 | | | 37 | | |
| 38 | |--run/ //-- Handy shell scripts | 38 | |--run/ //-- Handy shell scripts |
| 39 | ``` | 39 | ``` |
| 40 | 40 | ||
| 41 | ##Install application | 41 | ##Install application |
| 42 | |||
| 43 | install meteor from [this link](https://www.meteor.com/install). | ||
| 44 | |||
| 45 | install git and clone this repo. | ||
| 46 | |||
| 47 | |||
| 42 | ``` | 48 | ``` |
| 43 | $ cd ydapp/ | 49 | $ cd ydapp/ |
| 44 | ``` | 50 | ``` |
| 45 | ``` | 51 | ``` |
| 46 | $ npm install | 52 | $ npm install |
| 47 | ``` | 53 | ``` |
| 48 | 54 | ||
| 49 | ``` | 55 | ``` |
| 50 | $ ./run/app | 56 | $ ./run/app |
| 51 | ``` | 57 | ``` |
| 52 | ##Reset development environment | 58 | ##Reset development environment |
| 53 | To reset Meteor fixtures and clean the development environment. | 59 | To reset Meteor fixtures and clean the development environment. |
| 54 | ``` | 60 | ``` |
| 55 | $ ./run/reset_meteor | 61 | $ ./run/reset_meteor |
| 56 | ``` | 62 | ``` |
| 57 | 63 | ||
| 58 | ##Production Deployment | 64 | ##Production Deployment |
| 59 | //-- To do | 65 | //-- To do |