Skip to content

Commit cee4467

Browse files
committed
Migrating from npm and bower to yarn and updating readme
1 parent 3af1ff5 commit cee4467

File tree

2 files changed

+23
-273
lines changed

2 files changed

+23
-273
lines changed

README.md

Lines changed: 23 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
A very smart filemanager to manage your files in the browser developed in AngularJS following Material Design styles by [Jonas Sciangula Street](https://github.com/joni2back)
44

5-
This project provides you a font-end interface in order to allow you to create your own backend connector following the [connector API](API.md).
6-
7-
By the way, we provide some backend connectors in many languages as example (ftp, local files, etc)
5+
This project provides a web file manager interface, **allowing you to create your own backend connector** following the [connector API](API.md).
6+
*By the way, we provide some example backend connectors in many languages as example (php-ftp, php-local, python, etc)*
87

98
[![Build Status](https://travis-ci.org/joni2back/angular-filemanager.svg?branch=master)](https://travis-ci.org/joni2back/angular-filemanager)
109

@@ -21,10 +20,10 @@ Donate by Bitcoin wallet: ```147ca6be-a6a5-4012-8209-8ec94ff340b8```
2120
![](https://raw.githubusercontent.com/joni2back/angular-filemanager/master/screenshot.gif)
2221

2322
### Features
24-
- Multilanguage (English, Chinese, Spanish, Russian, Portuguese, French, German, Italian, Slovak, Hebrew, Persian, Polish, Ukrainian, Turkish, etc...)
25-
- Multiple templates (List / Icons)
26-
- Multiple file upload
2723
- Multiple file support
24+
- Multilanguage
25+
- List and Icon view
26+
- Multiple file upload
2827
- Pick files callback for third parties apps
2928
- Search files
3029
- Directory tree navigation
@@ -35,27 +34,27 @@ Donate by Bitcoin wallet: ```147ca6be-a6a5-4012-8209-8ec94ff340b8```
3534

3635
### TODO
3736
- Drag and drop
38-
- Dropbox and Google Drive compatibility
39-
- Extend backend bridges (PHP, Java, Python, Node, .Net)
40-
- Migrate jQuery to native or angular.element
37+
- Dropbox and Google Drive connectors
38+
- Remove usage of jQuery
4139

4240
### Backend API
4341
[Read the docs](API.md)
4442

4543
---------
4644

47-
### Use in your existing project
48-
**1) Install and use**
49-
```bower install --save angular-filemanager```
45+
### Using in your existing project
46+
**1) Install deps using yarn with**
47+
```yarn install```
5048

5149
**2) Include the dependencies in your project**
5250
```html
5351
<!-- third party -->
54-
<script src="bower_components/angular/angular.min.js"></script>
55-
<script src="bower_components/angular-translate/angular-translate.min.js"></script>
56-
<script src="bower_components/jquery/dist/jquery.min.js"></script>
57-
<script src="bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
58-
<link rel="stylesheet" href="bower_components/bootswatch/paper/bootstrap.min.css" />
52+
<script src="node_modules/jquery/dist/jquery.min.js"></script>
53+
<script src="node_modules/angular/angular.min.js"></script>
54+
<script src="node_modules/angular-translate/dist/angular-translate.min.js"></script>
55+
<script src="node_modules/ng-file-upload/dist/ng-file-upload.min.js"></script>
56+
<script src="node_modules/bootstrap/dist/js/bootstrap.min.js"></script>
57+
<link rel="stylesheet" href="node_modules/bootswatch/paper/bootstrap.min.css" />
5958

6059
<!-- angular-filemanager -->
6160
<link rel="stylesheet" href="dist/angular-filemanager.min.css">
@@ -69,35 +68,7 @@ Donate by Bitcoin wallet: ```147ca6be-a6a5-4012-8209-8ec94ff340b8```
6968

7069
---------
7170

72-
### Using source files instead of minified js
73-
```html
74-
<!-- Uncomment if you need to use raw source code
75-
<script src="src/js/app.js"></script>
76-
<script src="src/js/directives/directives.js"></script>
77-
<script src="src/js/filters/filters.js"></script>
78-
<script src="src/js/providers/config.js"></script>
79-
<script src="src/js/entities/chmod.js"></script>
80-
<script src="src/js/entities/item.js"></script>
81-
<script src="src/js/services/apihandler.js"></script>
82-
<script src="src/js/services/apimiddleware.js"></script>
83-
<script src="src/js/services/filenavigator.js"></script>
84-
<script src="src/js/providers/translations.js"></script>
85-
<script src="src/js/controllers/main.js"></script>
86-
<script src="src/js/controllers/selector-controller.js"></script>
87-
<link href="src/css/animations.css" rel="stylesheet">
88-
<link href="src/css/dialogs.css" rel="stylesheet">
89-
<link href="src/css/main.css" rel="stylesheet">
90-
-->
91-
92-
<!-- Comment if you need to use raw source code -->
93-
<link href="dist/angular-filemanager.min.css" rel="stylesheet">
94-
<script src="dist/angular-filemanager.min.js"></script>
95-
<!-- /Comment if you need to use raw source code -->
96-
```
97-
98-
---------
99-
100-
### Extending the configuration file
71+
### Extending the configuration file by adding a script
10172
```html
10273
<script type="text/javascript">
10374
angular.module('FileManagerApp').config(['fileManagerConfigProvider', function (config) {
@@ -120,6 +91,11 @@ angular.module('FileManagerApp').config(['fileManagerConfigProvider', function (
12091
</script>
12192
```
12293

94+
### Create a new build with your changes
95+
```sh
96+
gulp build || node node_modules/gulp/bin/gulp.js build
97+
```
98+
12399
You can do many things by extending the configuration. Like hide the sidebar or the search button. See [the list of default configurations](/src/js/providers/config.js).
124100

125101
---------
@@ -132,6 +108,4 @@ task `gulp build`. The minified/uglified files are created in the `dist` folder.
132108
For transparency into our release cycle and in striving to maintain backward compatibility, angular-filemanager is maintained under [the Semantic Versioning guidelines](http://semver.org/).
133109

134110
### Copyright and license
135-
Code and documentation released under [the MIT license](https://github.com/joni2back/angular-filemanager/blob/master/LICENSE).
136-
137-
111+
Code and documentation released under [the MIT license](https://github.com/joni2back/angular-filemanager/blob/master/LICENSE).

pom.xml

Lines changed: 0 additions & 224 deletions
This file was deleted.

0 commit comments

Comments
 (0)