Skip to content

Commit 2a3d3c9

Browse files
authored
Merge pull request #11 from amrita019/master
Update README.md
2 parents 9a2bf8a + 9adf49a commit 2a3d3c9

9 files changed

Lines changed: 81 additions & 0 deletions

File tree

.DS_Store

-8 KB
Binary file not shown.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules/
22
.env
33
package-lock.json
4+
.DS_Store

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,81 @@
1+
<p align="center">
2+
<img src="client/src/media/nodecloudlogo.png">
3+
</p>
4+
15
# nodecloud-web
6+
7+
nodecloud-web provides an interactive front-end for [nodecloud](https://github.com/cloudlibz/nodecloud). NodeCloud is a standard library to get a single API on the open cloud with multiple providers.
8+
Making open cloud easily accessible and managed.
9+
10+
![screenshot](screenshots/screenrecord.gif)
11+
12+
## clone or download
13+
14+
```sh
15+
$ git clone https://github.com/cloudlibz/nodecloud-web.git
16+
$ npm i
17+
```
18+
19+
## Project Structure
20+
21+
```
22+
server/
23+
package.json
24+
.env (to create .env, check [prepare your secret session])
25+
client/
26+
package.json
27+
...
28+
```
29+
30+
## Usage (run fullstack app on your machine)
31+
32+
## Client Side (PORT: 8081)
33+
34+
```sh
35+
$ cd client // go to client folder
36+
$ npm i // npm install pacakges
37+
38+
// deployment for client app
39+
$ npm start // this will compile the react code using webpack and run them at port 8081 by default
40+
```
41+
42+
## Server Side (PORT: 4000)
43+
44+
## Prepare your secret
45+
46+
You need to add a JWT_SECRET in .env
47+
48+
## Start
49+
50+
```sh
51+
$ cd server // go to server folder
52+
$ npm i // npm install pacakges
53+
$ npm run // this will build the server code
54+
```
55+
56+
## Docker
57+
58+
```sh
59+
$ cd nodecloud-web
60+
$ docker-compose up
61+
```
62+
63+
## API Documentation
64+
65+
[API docs](https://app.swaggerhub.com/apis/amrita019/nodecloud-web/1.0.0)
66+
67+
## Screenshots
68+
69+
<p align="center">
70+
<img src="screenshots/Screenshot_Login.png">
71+
</p>
72+
<p align="center">
73+
<img src="screenshots/Screenshot_Dashboard.png">
74+
</p>
75+
<p align="center">
76+
<img src="screenshots/Screenshot_Create.png">
77+
</p>
78+
79+
## License
80+
81+
MIT

screenshots/Screenshot_Create.png

226 KB
Loading
320 KB
Loading

screenshots/Screenshot_Login.png

241 KB
Loading

screenshots/screenrecord.gif

143 KB
Loading

server/.DS_Store

-8 KB
Binary file not shown.

server/user.sqlite3

-20 KB
Binary file not shown.

0 commit comments

Comments
 (0)