Blame view

README.md 2.14 KB
6fd17fdff   deepak kumar   README.md edited ...
1
  Tech stack is Meteor in backend and react in front-end.
9508f883a   deepak kumar   README.md edited ...
2
  We are using react-router for all the routing purpose.
6fd17fdff   deepak kumar   README.md edited ...
3

65c7e73ab   deepak kumar   README.md edited ...
4
5
  ##File Structure
  ```
a6c118bdf   deepak kumar   README.md edited ...
6
    |
7320f1663   deepak kumar   README.md edited ...
7
    |--ydapp/
65c7e73ab   deepak kumar   README.md edited ...
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
    |  |--client
    |  |  |--styles/         //-- All the styles
    |  |  |  |--components/  //-- Depreciated LESS styles
    |  |  |  |--layouts/     //-- SCSS styles
    |  |  |  |--lib/         //-- Styling variables
    |  |  |  |--mixins/      //-- All the mixins
    |  |  |  |--vendor/      //-- Fonts and icons
    |  |  |  |--views/       //-- SCSS styles
    |  |  |--main.html       //-- Main
    |  |  |--main.js         //-- Import main
    |  |--imports/
    |  |  |--client/           //-- Application logic
    |  |  |  |--app/           //-- App routes and some common components
    |  |  |  |--views/         //-- All the view part
    |  |  |  |  |--app/
    |  |  |  |  |--etc/        //-- some sample files
    |  |  |  |  |--invalidOrg/ //--View when someone enter a non registered subdomain
    |  |  |  |  |--nonOrg/     //--View for main site 
    |  |  |  |  |--Org/        //--Organisation specific vies
    |  |  |--collections/    //-- Application collections
    |  |  |--server/         //-- Server side processing and integrations
    |  |--private/
    |  |  |--fixtures/       //-- Application fixtures
    |  |--public/
    |  |  |--files/          //-- Raw fonts and SVG assets
    |  |--server/            //-- Main JS
    |  |--tests/             //-- For running tests
    |  |--package.json       //-- Node.js dependencies
    |
    |
e32629f48   deepak kumar   README.md edited ...
38
    |  |--run/                  //-- Handy shell scripts
65c7e73ab   deepak kumar   README.md edited ...
39
  ```
a3a1cb9c4   Ryan Glover   update README.md
40

65c7e73ab   deepak kumar   README.md edited ...
41
  ##Install application
4935c163f   deepak kumar   README.md edited ...
42
43
44
45
  
  install meteor from [this link](https://www.meteor.com/install).
  
  install git and clone this repo.
a6c118bdf   deepak kumar   README.md edited ...
46
  cd into the `ydapp` folder
4935c163f   deepak kumar   README.md edited ...
47

65c7e73ab   deepak kumar   README.md edited ...
48
  ```
6fd17fdff   deepak kumar   README.md edited ...
49
  $ cd ydapp/
65c7e73ab   deepak kumar   README.md edited ...
50
  ```
b7728aac4   deepak kumar   README.md edited ...
51
52
  
  to install all the dependencies, run below command
65c7e73ab   deepak kumar   README.md edited ...
53
  ```
b7728aac4   deepak kumar   README.md edited ...
54
  $ meteor npm install
65c7e73ab   deepak kumar   README.md edited ...
55
  ```
b7728aac4   deepak kumar   README.md edited ...
56
  To start the app
65c7e73ab   deepak kumar   README.md edited ...
57
58
59
  ```
  $ ./run/app
  ```
b7728aac4   deepak kumar   README.md edited ...
60
61
62
63
64
65
66
67
68
69
  above command won't run for windows.
  For windows only, run below command to start the app
  ```
  meteor --settings settings-development.json
  ```
  
  go to below URL to check the running app
  ```
  localhost:3000
  ```
65c7e73ab   deepak kumar   README.md edited ...
70
71
72
73
74
75
76
77
  ##Reset development environment
  To reset Meteor fixtures and clean the development environment.
  ```
  $ ./run/reset_meteor
  ```
  
  ##Production Deployment       
  //-- To do