This project was generated with Angular CLI version 1.4.2.
Shanfang Zhao Github: Shanfang
Xiaohui Huang Github: CindyHXH
Lujia Yu Github: vicyu666
Haoran Yu Github: jeness
SmartNote is a notes app based on Angualr 4, MongoDB and Node.js developed by Group Augo.
Check our demo here at SmartNote.
- Account management: sign in, sign out.
- Basic notes: Create, Retrieve, Update, Delete
- URL notes: generate note from URL automatically.
- Markdown notes: create a markdown note with its title, tag and content.
- Archive note: view all archived notes.
- Classification: classify note by tags.
- View note: preview url note and markdown note.
- Edit note: modify markdown note.
- Delete note.
- Tag notes: create tags and classify notes by tag.
- Search notes: search note by keyword or tag.
- Install homebrew and nodejs
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install node
- Before run our application, you need to install mongodb.
- Open the Terminal app and type
brew update
. - After updating Homebrew
brew install mongodb
- After downloading Mongo, create the โdbโ directory. This is where the Mongo data files will live. You can create the directory in the default location by running
mkdir -p /data/db
- Make sure that the /data/db directory has the right permissions by running
sudo chown -R `id -un` /data/db
.
-
Run
mongod
in the terminal to start the the Mongo daemon, this step starts the Mongo serever. -
Before starting the application, you need to install some dependencies. Please reference the next section for details. Run
npm run start
to start the application. Navigate tohttp://localhost:4300/
. The app will automatically reload if you change any of the source files. -
For Server part, go to folder server by
cd server/
. Runnpm install
andnpm run dev
. -
Exit mongo service:
- To exit the Mongo shell run
quit()
- to quit the Mongo daemon, hit
ctrl-c
.
- Backend Testing:
- To install Mocha and Chai using
npm install -g mocha
.npm install chai
.npm install supertest --save-dev
. And to run backend test in the folder /smartnote usingmocha test.js
.
We deployed our project on a server SmartNote.
For markdown directives, you need to install some libraries.
Install SimpleDEM and Highlight for markdown note features.
-
navigate to app root directory(./smart-note), run
npm install simplemde --save
andnpm install angular-highlightjs --save
to install dependencies for markdown functionality. -
navigate to ./server, run
npm install nodemon --save
Run ng generate component component-name
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module
.
Run ng build
to build the project. The build artifacts will be stored in the dist/
directory. Use the -prod
flag for a production build.
Run mocha test.js
to execute the backend tests via Mocha.
Run ng test
to execute the unit tests via Karma.
Before that, you need to install dependencies of karma-coverage, please run npm install karma karma-coverage --save-dev
.
Run ng e2e
to execute the end-to-end tests via Protractor.
Before running the tests make sure you are serving the app via ng serve
.
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.