Personal project to learn Node.js. Here are the broad requirements of the project.
- Shared calendar
- Ability to add appointments for each person
- View schedule by month, week, day
- Fitter schedule by person
- Reminder email / SMS
- Lists
- Add different lists
- Add items to each list
- Tick off items from list. Should be reflected instantly in all open instances
- Photos
- Add albums
- Add photos to albums
- Add notes to photos
- Chat
- Notification when someone logs in
- Create a chat room
- Allow owner of chat room to add more logged in users
- Save chat transcript
- Authentication & Authorization.
- Authenticate users to access the applications (3rd party oAuth)?
- Authorization levels can be set up which allow access to view, add, update or delete resources.
- Admin functionality
- Look and feel modifications
- Add / edit users and access roles
- Responsive
- should work in mobile, tablets and desktop.
- specific views for each display size (to be detailed)
I'm using this project to learn how to create a web application using Node.js. Another ulterior motive is to try out the different Node.js frameworks out there (No Framework, Express, Sails, Hapi, Kraken, etc.) and also front end frameworks (angular.js, ember.js, react / flux, backbone)
Clone the project
git clone https://github.com/prabinv/FamilyPortal/ FamilyPortal
or fork the project
Run npm install
Run node server.js
and open http://localhost:3000 in your browser.
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Describe and show how to run the tests with code examples.
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
MIT