This is dictionary app for grownups with bi-lingual toddlers. Basically it lets you make records with phonetic words said by the kiddo, what it means, and the translated word. Right now it's setup for Czech and English, but this can be changed in the config file. It's based on the angular seed by Tiago Reis. That can be found here > https://github.com/tiagodreis/angularseed
I basically stripped out requireJS, as I find it silly for small projects, and added Grunt as the build tool. Most of this read me is the same as the original, so I'll leave it in place.
Core technologies used
- Express Framework
- MongoDB (mongoose)
(Other libraries used: Passport, Nodemailer and crypto)
First, make sure you have Node, Grunt, and Mongo DB installed.
Then you can build the project.
npm install(with administration rights)
gruntto build out the app directory (check the gruntfile for more tasks)
mongodto start the mongo db instance
node app.jsto start the node server
Then aim the browser at localhost:3000
While working on the project, run
grunt or one of the grunt subtasks found in gruntfile.js to compile all the files.
You'll need to do this after each change, or run one of the "watch" tasks to have it happen automatically.
You only need to run
npm install when you first initialize the project. If you add any modules (angular or jQuery) be sure to add them via npm, so the project is easy to build later on.
This Seed provides users with PassportJS registration / authentication and AngularJS as the client framework, as well as Grunt build tasks.
Upon registration, the application sends a confirmation e-mail (make sure you use a valid email address that you can check for the confirmation email). As for now, I'm not doing anything with it, but I plan to add more features sometime soon (Tests are a must).
app.js --> web server
package.json --> package dependencies
gruntfile.js --> grunt setup stuffs
app/ --> main client app
css/ --> css files, get built by Grunt
views/ --> main view and partials, get built by Grunt
assets/ --> images, audio, etc, get built by Grunt
src/ --> src folder for all client-side app files
css/ --> css files, gets built by Grunt
controllers/ --> everything in here gets concat'd into controllers.js
components/ --> everything in here gets concat'd into components.js
services/ --> everything in here gets concat'd into services.js
views/ --> main view and partials, these get processed and copied to app/views
assets/ --> images, audio, etc, get copied to app/assets by Grunt, with folders intact
config/ --> application config folder
app(.)-strings.js --> re-usable strings used by application
config.js --> app default configs (db name, etc)
conf(.)-routes.js --> routing passing point
mailer.js --> mailer module
passport.js --> passportjs configuration
routes.js --> routes's implementation
server/ --> server side logic
api/ --> api for model manipulation
helpers/ --> generic helpers (I added an encryption helper) models/ --> mongoose models