TreeBook is the definitive social networking site for trees.
The folder structure used was provided by mean.io. They have extensive documentation on the folder structure and how best to program in it. We strongly recommend taking time to go through the folder structure and understand how the logic flows.
├── config/
│ ├── env/ // Configuration files for different environments.
│ ├── packages/ // Application logic
│ │ ├── articles/ // Logic for tree functionality
│ │ ├── system/ // Logic for all non tree and non user pages (index, about, etc)
│ │ ├── theme/ // Logic for styling and components (header / footer)
│ │ ├── users/ // Logic for users
Each of articles, system, then and users loosely has the following structure
├── public/ // Front end files
│ ├── assets/ // Css and images
│ ├── controllers/ // Angular controllers
│ ├── routes/ // Angular routes for front end logic
│ ├── services/ // Angular services
│ ├── tests/ // Mocha tests
│ ├── views/ // HTML
├── server/ // Holds all backend files
│ ├── controllers/ // Backend controllers
│ ├── routes/ // Express routes
In order to help you understand the folder structure we will walk through how data flows through the application logic for a specific use.
When a user posts a message on the tree profile page - 'SubmitMessage' is invoked in packages/articles/public/controllers/MessagesController.js 'SubmitMessage' uses the the 'Messages' factory in packages/articles/public/services/articles.js A post request is submitted to /usermessages Express routes the request via packages/articles/server/routes/MessagesController.js to 'postMessagesFromUser' In packages/articles/server/controllers/articles.js 'postMessagesFromUser' inserts the message into the database
TBSECRET // Secret Key for cookies APPLICATIONID // ChatBot API AZURE_STORAGE_ACCOUNT // Storage for image uploads AZURE_STORAGE_ACCESS_KEY // Storage for image uploads POSTGRES // SQL DB with tree data TBEMAIL // Email for reset password TBPASS // Email for reset password NODE_ENV // Env
We believe that mean should be free and easy to integrate within your existing projects so we chose The MIT License
- Refactor much of the code from 'articles' to 'trees'
- Build admin functionality. Mean.io has the capabilities to set admin users already.
- Implement tests. Although testing is currently implemented only very basic tests have been implemented.
- Move certain logic out of 'articles' folder. This folder holds a lot of excess logic that ideally would be placed elsewhere. I.e. messages functionality moved to a new 'messages' folder.
- Styling improvements.
- Optimizations. Currently there are a significant number of angular watchers on each profile page that could potentially be removed.