Skip to content

Commit bf336ab

Browse files
author
Alexandru Vladutu
committed
Added screenshots & updated README
1 parent 3b8dabd commit bf336ab

File tree

5 files changed

+10
-4
lines changed

5 files changed

+10
-4
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## What's this?
2+
3+
ClientManager is a sample CRUD application build with Backbone, RequireJS (2.0) and Twitter Bootstrap on the frontend. The backend part of the application uses Express.js and Mongoose (amongst other libraries).
4+
5+
<img src="https://github.com/alessioalex/ClientManager/raw/master/files/add_client.png" border="0" />
6+
<img src="https://github.com/alessioalex/ClientManager/raw/master/files/client_list.png" border="0" />
7+
18
## Quick start
29

310
- Make sure Node.js and NPM should be installed (I prefer to do it using NVM). This project was developed on Node 0.6.x.
@@ -7,11 +14,11 @@
714

815
- Configure the ports for the application (for multiple environments: dev, test, production) and also the settings for the MongoDB connection (you can either host MongoDB locally or try a free hosting provider such as MongoLab). The config data is in /config
916
- Start the server:
10-
17+
1118
a) Production
1219

1320
npm start
14-
21+
1522
b) Development (note that if you want to load all the files uncompressed you should visit http://&lt;server&gt;:&lt;port&gt;/dev.html):
1623

1724
node app.js

files/add_client.png

52.6 KB
Loading

files/client_list.png

81.4 KB
Loading

public/build/main-built.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

public/js/templates/home.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,5 @@ <h2>Download</h2>
1212
<div class="span6">
1313
<h2>Get it up & running</h2>
1414
<p>Node.js and NPM need to be installed on your server/PC. Run "npm install ." on the command line (inside the project) to install the dependencies. Then make sure to configure the MongoDB connection details (/config/db.json) and other app settings (such as port). If you are running MongoDB with the default settings on localhost you won't need to change anything. When you're all set, run "npm start" and enjoy :)</p>
15-
<p><a class="btn" href="#">View details &raquo;</a></p>
1615
</div>
1716
</div>

0 commit comments

Comments
 (0)